Modify Return Order | ShipBob Developer API

curl -X PUT https://sandbox-api.shipbob.com/1.0/return/1 \
     -H "shipbob_channel_id: 1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json-patch+json" \
     -d '{
  "fulfillment_center": {
    "id": 0,
    "name": "Cicero (IL)"
  },
  "inventory": [
    {
      "id": 111222,
      "quantity": 1,
      "requested_action": 0
    }
  ],
  "reference_id": "ShipBob_Return_123",
  "original_shipment_id": 123456,
  "tracking_number": "1Z9999999999999999"
}'

{
  "channel": {
    "id": 0,
    "name": "ShipBobs-Shopify-Store"
  },
  "completed_date": "2019-08-24T14:15:22+00:00",
  "customer_name": "string",
  "fulfillment_center": {
    "id": 0,
    "name": "Cicero (IL)"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22+00:00",
  "inventory": [
    {
      "action_requested": {
        "action": 0,
        "action_type": "InventoryDefault",
        "instructions": "string"
      },
      "action_taken": [
        {
          "action": 0,
          "action_reason": "string",
          "lot_information": [
            {
              "expiration_date": "2019-08-24T14:15:22+00:00",
              "lot_number": "string",
              "quantity_processed": 0
            }
          ],
          "quantity_processed": 1
        }
      ],
      "id": 0,
      "name": "string",
      "quantity": 0
    }
  ],
  "invoice_amount": 0.1,
  "original_shipment_id": 0,
  "reference_id": "string",
  "return_type": "Regular",
  "status": "AwaitingArrival",
  "store_order_id": "string",
  "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
  "transactions": [
    {
      "amount": 2.5,
      "transaction_type": "ReturnLabelInvoice"
    }
  ]
}

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

idintegerRequired

Id of the return order

Request

Model defining the return

fulfillment_centerobjectRequired

Information about a fulfillment center

inventorylist of objectsRequired

Array of inventory items being returned

reference_idstringRequired<=50 characters

Client-defined external unique identifier for the return order

original_shipment_idintegerOptional

Shipment from which the items in the return originated

tracking_numberstringOptional<=500 characters

Tracking number for the return shipment

Response

Success

channelobject

Created by channel metadata

completed_datedatetime

Completed date for a return order.

customer_namestring

Customer name from the related shipment.

fulfillment_centerobject

Information about a fulfillment center

idinteger

Unique id of the Return Order

insert_datedatetime

Date this return order was created

inventorylist of objects

List of inventory included in the return order

invoice_amountdouble

Invoiced amount of return order (sum of transaction amounts)

original_shipment_idinteger

Id of the corresponding shipment that is the souce of the return

reference_idstring

Client-defined external unique id of the return order

return_typeenum

statusenum

store_order_idstring

Store order for the related shipment.

tracking_numberstring

Tracking number of the return shipment

transactionslist of objects

Array of transactions affiliated with the return order

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors