REST Order Shipping Package Items

Create, get, update and delete order shipping package items.

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

Success 200

Field Type Description
id Int The ID of the order shipping package item. Primary key auto-increment
packageId Int The ID of the package (id column from plenty_package_type2order)
itemId Int The ID of the item (plenty_item_variation_base_item_id column from plenty_item_variation_base)
variationId Int The ID of the variation (plenty_item_variation_base_id column from plenty_item_variation_base)
itemQuantity Float The quantity of the item in 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.

/rest/orders/shipping/packages/{packageId}/items

Success 200

Field Type Description
id Int The ID of the order shipping package item. Primary key auto-increment
packageId Int The ID of the package (id column from plenty_package_type2order)
itemId Int The ID of the item (plenty_item_variation_base_item_id column from plenty_item_variation_base)
variationId Int The ID of the variation (plenty_item_variation_base_id column from plenty_item_variation_base)
itemQuantity Float The quantity of the item in 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.

/rest/orders/shipping/packages/{packageId}/items

Success 200

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.

/rest/orders/shipping/packages/items/{id}

Success 200

Field Type Description
contentType String response content type
contentLength Int response content length
content String response content

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.

/rest/orders/shipping/packages/items/{id}

Success 200

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.

/rest/orders/shipping/packages/items/{packageId}/{itemId}/{variationId}

Success 200

Field Type Description
contentType String response content type
contentLength Int response content length
content String response content

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.

/rest/orders/shipping/packages/items/{packageId}/{itemId}/{variationId}

Success 200

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!