Get Containers

get

https://api.proshipping.net/v4/containers

Provides a list of all containers set up on the system.
Information about the associated carrier, shipping location, total weight, number of shipments and packages in the containers will be returned.

Query Params

carrierCode

string

CarrierCode
Filter by carrier

shippingLocationId

string

Shipping Location Id
PRO SHIPPING Shipping Location Id (assigned by PRO SHIPPING) or Alias (assigned by you).
Filter by shipping location

pageSize

int32

1 to 2147483647

Defaults to 100

The maximum number of records per page.

pageNumber

int32

1 to 2147483647

Defaults to 1

The number of the requested page, starting at 1.

sortBy

string

enum

Sort By
Default: CreatedDateUtc

Allowed:

sortDir

string

enum

Sort Direction
Default: Ascending

Allowed:

containerStatus

string

enum

The status of the container
Default: Active

Allowed:

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200Returns a list of containers.

400Invalid request response.