REST Order ShippingPackageType

List all shipping package types or get a shipping package type by the ID.

Get a shipping package type

Gets a shipping package type. The ID of the shipping package type must be specified.

/rest/orders/shipping/package_types/{shippingPackageTypeId}

Success 200

Field Type Description
id Int The ID of the shipping package type
name String The name of the shipping package type
width Int The width of the shipping package type
height Int The height of the shipping package type
length Int The length of the shipping package type
unit String The unit of the shipping package type dimension
maxWeight Int The maximum weight of the shipping package type
maxVolume Int The maximum volume of the shipping package type
volumeType Int The volume type of the shipping package type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List shipping package types

/rest/orders/shipping/package_types

Success 200

Field Type Description
id Int The ID of the shipping package type
name String The name of the shipping package type
width Int The width of the shipping package type
height Int The height of the shipping package type
length Int The length of the shipping package type
unit String The unit of the shipping package type dimension
maxWeight Int The maximum weight of the shipping package type
maxVolume Int The maximum volume of the shipping package type
volumeType Int The volume type of the shipping package type

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!