REST Order Shipping Package

Create, get, update and delete order shipping packages.

Get an order shipping package

Gets an order shipping package. The ID of the order and the ID of the order shipping package must be specified.

/rest/orders/{orderId}/shipping/packages/{orderShippingPackageId}

Parameters

Field Type Description
orderId Int The ID of the order
orderShippingPackageId Int The ID of the order shipping package
columns String[] The properties to be loaded

Success 200

Field Type Description
id Int The ID of the order shipping package
orderId Int The ID of the order
packageId Int The ID of the package
weight Int The weight of the package in grams
packageNumber String The package number
labelPath String The path to the label
labelBase64 String The base64 encoded label
exportLabelBase64 String The base64 encoded export label
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
volume Float The volume of the package
{"orderId":241,"packageId":7,"weight":226,"packageNumber":"7ItrQlbBs","labelPath":"\/path\/to\/label.pdf","packageType":22,"volume":736.28,"id":296}

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 order shipping packages

Lists order shipping packages. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/packages

Parameters

Field Type Description
orderId Int The ID of the order
columns String[] The properties to be loaded
with String Possible value is 'labelBase64'

Success 200

Field Type Description
id Int The ID of the order shipping package
orderId Int The ID of the order
packageId Int The ID of the package
weight Int The weight of the package in grams
packageNumber String The package number
labelPath String The path to the label
labelBase64 String The base64 encoded label
exportLabelBase64 String The base64 encoded export label
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
volume Float The volume of the package
[{"orderId":335,"packageId":1,"weight":757,"packageNumber":"t2pxTdoH","labelPath":"\/path\/to\/label.pdf","packageType":6,"volume":725.62,"id":629},{"orderId":409,"packageId":5,"weight":375,"packageNumber":"HWhsNfqRm7C","labelPath":"\/path\/to\/label.pdf","packageType":36,"volume":293.73,"id":333}]

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.

Create an order shipping package

Creates an order shipping package. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/packages

Parameters

Field Type Description
orderId Int The ID of the order

Request

Field Type Description
packageId Int The ID of the package required
weight Int The weight of the package in grams optional
packageNumber String The package number optional
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
required
volume Float The volume of the package optional
labelPath String The path to the label optional
{"packageId":5,"weight":741,"packageNumber":"snrbkODogF4","packageType":15,"volume":673.17}

Success 200

Field Type Description
id Int The ID of the order shipping package
orderId Int The ID of the order
packageId Int The ID of the package
weight Int The weight of the package in grams
packageNumber String The package number
labelPath String The path to the label
labelBase64 String The base64 encoded label
exportLabelBase64 String The base64 encoded export label
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
volume Float The volume of the package

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.

Update an order shipping package

Updates an order shipping package. The ID of the order and the ID of the order shipping package must be specified.

/rest/orders/{orderId}/shipping/packages/{orderShippingPackageId}

Parameters

Field Type Description
orderId Int The ID of the order
orderShippingPackageId Int The ID of the order shipping package

Request

Field Type Description
packageId Int The ID of the package optional
weight Int The weight of the package in grams optional
packageNumber String The package number optional
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
optional
volume Float The volume of the package optional
{"packageId":5,"weight":788,"packageNumber":"6pCXlNDOu54Z","packageType":14,"volume":465.98}

Success 200

Field Type Description
id Int The ID of the order shipping package
orderId Int The ID of the order
packageId Int The ID of the package
weight Int The weight of the package in grams
packageNumber String The package number
labelPath String The path to the label
labelBase64 String The base64 encoded label
exportLabelBase64 String The base64 encoded export label
packageType Int The type of the package. The following types are valid:
  • 0: unpacked
  • 1: Bale
  • 2: Dispenser
  • 3: Coil
  • 4: Roll pallet
  • 5: Colli
  • 6: Container
  • 7: Bucket
  • 8: Cask
  • 9: Bottles
  • 10: European flat pallet
  • 11: Structural frame
  • 12: Gas cylinder
  • 13: Pallet cage
  • 14: Hobbock
  • 15: Half pallet
  • 16: Pallet of food items
  • 17: Wooden coaster
  • 18: IBC container
  • 19: Pitcher
  • 20: Wicker bottle
  • 21: Case
  • 22: Canister
  • 23: Customer pallet
  • 24: Cardboard box
  • 25: Composite packaging
  • 26: Package
  • 27: Ring
  • 28: Role
  • 29: Sack
  • 30: units
  • 31: Tank
  • 32: Drum
  • 34: Crate
  • 35: Quarter pallet
  • 36: Other pallets
  • 37: Bin
  • 38: One-way pallet
  • 39: Foil bag
volume Float The volume of the package

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.

Delete an order shipping package

Deletes an order shipping package. The ID of the order and the ID of the order shipping package must be specified.

/rest/orders/{orderId}/shipping/packages/{orderShippingPackageId}

Parameters

Field Type Description
orderId Int The ID of the order
orderShippingPackageId Int The ID of the order shipping package

Success 200

This call does not have a response output.

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.

Delete all order shipping packages for an order

Deletes all order shipping packages for an order. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/packages

Parameters

Field Type Description
orderId Int The ID of the order

Success 200

This call does not have a response output.

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!