Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Containers

Add Container

Create and name (with and ID or alias) a new container to be used for manifesting a specific group of shipments. Define which carrier and shipping location the container should be linked to.

post/v4/containers

Request body

CarrierCodestring required

Carrier Code

ShippingLocationIdstring required

Shipping Location Id <br />SAPIENT Shipping Location Id (assigned by SAPIENT) or Alias (assigned by you) of the shipping location that this container is for.

ContainerIdstring nullable

Container Id <br />The Container Name/Alias for this container <br />Defaults to a globally unique identifier.

Example request

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

Response

The container has been successfully created.

ContainerIdstring required

Container Id <br />The Container Identifier

CreatedDateUtcstring date-time required

Created Date UTC

CreatedDatestring date-time required

Created Date

CarrierCodestring required

Carrier Code <br />The carrier that the container is for.

ShippingLocationIdstring required

Shipping Location <br />The shipping location name/alias that this container is for.

Example response

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