REST Order Serial Numbers

List serial numbers for orders

List serial numbers of an order

Lists all serial numbers of an order. The ID of the order must be specified.

/rest/orders/{orderId}/items/serialNumbers

Parameters

Field Type Description
orderId Int The ID of the order

Success 200

Field Type Description
serialNumberId Int The ID of the serial number
orderId Int The ID of the order
orderItemId Int The ID of the order item
serialNumber String The serial number
[{"orderId":329,"orderItemId":113,"serialNumber":"413564788798","serialNumberId":430},{"orderId":450,"orderItemId":122,"serialNumber":"566448097906","serialNumberId":147}]

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 serial numbers of an order item

Lists all serial numbers of an order item. The ID of the order and the ID of the order item must be specified.

/rest/orders/{orderId}/items/{orderItemId}/serialNumbers

Parameters

Field Type Description
orderId Int The ID of the order
orderItemId Int The ID of the order item

Success 200

Field Type Description
serialNumberId Int The ID of the serial number
orderId Int The ID of the order
orderItemId Int The ID of the order item
serialNumber String The serial number
[{"orderId":562,"orderItemId":564,"serialNumber":"059394134550","serialNumberId":869},{"orderId":204,"orderItemId":768,"serialNumber":"221781872996","serialNumberId":823}]

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!