The following how-to sections describe the steps necessary to create Containers using the Container API. The how-tos in this section use the example of a pallet and a box to illustrate the process.
- An account on the OS1 Platform and a Platform Tenant. For more information, see Getting started with the OS1 Platform.
- Credentials for an App on the OS1 Platform. For more information, see Getting started building Apps.
- An access token. For more information about creating an access token for testing purposes, see Postman Collection or How to use the API 'Try It' feature.
- A mechanism to call the endpoints. For testing purposes, you can use our Core API Postman Collection or the “Try It!” feature in our API Documentation.
- An App. To change the Lifecycle state of a Container, you must specify the App ID associated with the container. For information about registering an App and retrieving the Client ID, see the "Register an App" section of Getting started with building Apps.
To create and use a Container, you must:
- Create a Container Type. For more information, see How to: Create a Container Type.
- Create the Container. For more information, see How to: Create a Container.
- Update the Container States: Ensure that the Parent is open and the child container is closed. For more information, see How to: Change the Container state.
- Containerize the child container: For more information, see How to: Containerize a child Container.
- Update the parent Container State: Close the parent container.
Additionally, you can:
- View the Participant change log. For more information, see How to: View the Container change log.
Updated 12 days ago