API ReferenceReturns

Create Return Order

View as Markdown

Creates a return order. If purchase_label is true, also purchases a return shipping label using the original_shipment_id.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idintegerRequired
The unique identifier of the channel to scope this request to
creationSourceIdintegerOptionalDefaults to 3

Source of the return creation. Defaults to 3 (API)

Query parameters

api-versionstringOptionalDefaults to 1.0
The requested API version

Request

fulfillment_centerobjectOptional
A Facility to process Returns.
inventorylist of objectsOptional
Array of inventory items being returned
label_formatenumOptional

Optional label file format. Accepted values: PDF, PNG. If not provided, carrier default format is used. Only used when purchase_label is true

Allowed values:
original_shipment_idintegerOptional

Shipment from which the items in the return originated. Required when purchase_label is true

purchase_labelbooleanOptional

If true, purchases a return shipping label after creating the return order. Requires original_shipment_id

reference_idstringOptional

Client-defined external unique identifier for the return order. If tracking id is not provided, this value must appear on the box label as RMA

shipping_servicestringOptional

Ship option name (e.g. “UPS Ground”) for label purchase. Only used when purchase_label is true. Falls back to cheapest if not matched

tracking_numberstringOptional
Tracking number for the return shipment

Response

Return order created successfully

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error