POST /containers

Allows the caller to get a container label and associate packages to that container.

Servers

https://apis.usps.com/containers/v3
https://apis-tem.usps.com/containers/v3

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`sortType`	String	Yes	The sort type of the container being shipped. Valid values: `"TRUCK_BEDLOAD"` `"PALLET"` `"SACK"`
`mailClass`	String	Yes	The mail class of the items enclosed in the container. The default value is `PARCEL_SELECT` Valid values: `"PARCEL_SELECT"`
`destinationEntryFacilityType`	String	Yes	The facility type where the container will be sent to. Valid values: `"DESTINATION_SERVICE_HUB"` `"DESTINATION_DELIVERY_UNIT"` `"DESTINATION_NETWORK_DISTRIBUTION_CENTER"` `"DESTINATION_SECTIONAL_CENTER_FACILITY"`
`destinationZIPCode`	String	Yes	A 5-digit ZIP Code serviced by the `destinationEntryFacilityType` the container is being sent to. This is used to identify the Destination Entry Facility.
`mailerName`	String	Yes	Name of the firm/business that is shipping the container.
`containerTopology`	String	No	Valid values: `"NESTED"` Default value: "NESTED"
`containerID`	String	No	Unique identifier for a container
`trackingNumbers[]`	Array	No	List of tracking numbers for the packages that are in the container.
`processingCategory`	String	Yes	The type of packages that will be nested to the container. `MIXED` is only available for `DESTINATION_DELIVERY_UNIT` and `DESTINATION_SERVICE_HUB` containers. Note: `NON_MACHINABLE` is deprecated and will convert to `NONSTANDARD` as of 01/19/2025. Valid values: `"MACHINABLE"` `"NON_MACHINABLE"` `"NONSTANDARD"` `"MIXED"`
`MID`	String	Yes	Mailer Identifier to use to create the container barcode.
`warnings[]`	Array	No
`warnings[].warningCode`	String	No
`warnings[].warningDescription`	String	No
`imageInfo`	Object	No	Additional details used to determine how to generate the label image.
`imageInfo.imageType`	String	No	The type of label image requested. If omitted then the default image type is PDF. Note: When using `ZPL203DPI` or `ZPL300DPI` the image returned will be rotated 90 degrees and be 4x6 inches, instead of 6x4 inches. Valid values: `"GIF"` `"JPG"` `"PDF"` `"SVG"` `"ZPL203DPI"` `"ZPL300DPI"` `"TIFF"` `"NONE"` `"PNG"` Default value: "PDF"
`imageInfo.labelType`	String	No	Ability to select the label image size. If omitted then the default label size is 6X4LABEL. '6X4LABEL' Valid values: `"6X4LABEL"` Default value: "6X4LABEL"
`mailingDate`	String	No	The mailing date for when the container will be shipped, when included in the request all packages nested to the container will be updated to align with the associated mailingDate. The mailing date may be today plus 0 to 7 days in advance. If it is not provided it will be set as today.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.