Sign in
Containers

Add Container

Create and add new shipping containers to the system for manifesting specific group of shipments. With this endpoint, the system processes the creation of the specified container and associates it with a given carrier and shipping location. This API streamlines logistics management and helps ensure that container data is accurately maintained for shipping operations.

post/v4/containers

Request body

CarrierCodestring required

A unique identifier for the shipping carrier for which a container is being created. This code is alphanumeric and helps in identifying the specific carrier linked to the container.

ShippingLocationIdstring required

A unique identifier for the shipping location assigned by the system (ShippingLocationId) or by you (LocationAlias) where the container will be stored or from which it will be dispatched. This parameter links the new container to a specific physical location, aiding in inventory management and logistical operations.

ContainerIdstring nullable

A unique identifier for the new container being created. This ID is used to reference and manage the specific container within the PRO SHIPPING system, facilitating tracking and operational oversight. <br /> <br />Note: If this information is not provided, then by default, this field is set to the globally unique identifier (GUID).

Example request

{
  "CarrierCode": "RM",
  "ShippingLocationId": "Central Warehouse",
  "ContainerId": "South East 1234"
}

Response

The container has been successfully created.

ContainerIdstring required

The unique identifier assigned to the newly created container. This ID is returned to the user as confirmation that the container has been successfully added to the system.

CreatedDateUtcstring date-time required

A timestamp indicating when the container was created in the system, formatted in Coordinated Universal Time (UTC). This information helps users to track the age and relevance of their container records.

CreatedDatestring date-time required

The specific date on which the container was created. This provides a clear reference for users to understand when the container was added to the system.

CarrierCodestring required

A unique identifier for the shipping carrier associated with the new container. This code is alphanumeric and helps confirming which carrier will handle the shipping and logistics for that container.

ShippingLocationIdstring required

The unique identifier assigned by the user (alias) to the shipping location linked to the newly added container, providing context about where the container is stored or from where it will be despatched.

Example response

{
  "ContainerId": "South East 1234",
  "CarrierCode": "RM",
  "ShippingLocationId": "Northern Warehouse"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.