younifyd
Menu

Put 2026 07 Return Id

Edit Return Order

PUT/2026-07/return/{id}

Use it in a workflow

  1. Add a step and choose the ShipBob connector.
  2. Pick the Put 2026 07 Return Id action (under ShipBob).
  3. Fill in the fields below, then reference the result from later steps as {{put202607ReturnId.response.data}}.

Request

Path parameters

idinteger (int32)required

Request body

Enter the body as JSON in the step's Body field.

fulfillment_centerobjectrequired

A Facility to process Returns.

idinteger (int32)required

Unique identifier of the facility

namestring

Name of the facility (It is optional because public API integrations do not pass this)

inventoryarray<object>required

Array of inventory items being returned

idinteger (int32)required

ID of the inventory item to return.

lot_datestring (date-time)

Lot date associated with the inventory item, if applicable.

lot_numberstring

Lot number associated with the inventory item, if applicable.

quantityinteger (int32)required

Quantity of the returned inventory item in the return.

requested_actionstring (int32)required

One ofDefaultRestockQuarantineDisposeDonation

original_shipment_idinteger (int32)

Shipment from which the items in the return originated <example>123456</example>

reference_idstringrequired

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. <example>Example: ShipBob_Return_123</example>

tracking_numberstring

Tracking number for the return shipment <example>1Z9999999999999999</example>

json
{
  "fulfillment_center": {
    "id": 0,
    "name": "string"
  },
  "inventory": [
    {
      "id": 0,
      "quantity": 0,
      "requested_action": "Default",
      "lot_date": "2025-01-01T00:00:00Z",
      "lot_number": "string"
    }
  ],
  "reference_id": "string",
  "original_shipment_id": 0,
  "tracking_number": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{put202607ReturnId.response.data.<field>}}.

channelobject

The details of a Channel

idinteger (int32)

Unique Id of the channel

namestring

Name given to the channel

completed_datestring (date-time)

The date and time for when the return order was completely processed

customer_namestring

Name of merchant that return belongs to

fulfillment_centerobject

The details of a Fulfillment Center

idinteger (int32)

Unique id of the fulfillment center

namestring

Name give to the fulfillment center

idinteger (int32)

Unique id of the return order

insert_datestring (date-time)

The date and time for when the return order was created

inventoryarray<object>

List of inventory items in return order

action_requestedobject3 fields

The details of the action requested for inventory

action_takenarray<object>4 fields

List of actions taken

bundle_parent_skustring

SKU of the parent bundle if this item was expanded from a bundle. Null for non-bundle items

idinteger (int32)

Unique id of the inventory

namestring

Name of the product

quantityinteger (int32)

Number of inventory that is being returned

invoice_amountnumber (double)

Amount merchant was invoiced for processing the return

original_shipment_idinteger (int32)

ShipmentId for which return was created

reference_idstring

Unique reference id of the return order. Created by merchant if a regular return.

return_typestring

Type of the return, i.e. Regular, RTS

statusstring

Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`

store_order_idstring

Reference to external order id

tracking_numberstring

The tracking number of the return shipping label

transactionsarray<object>

List of transactions that make up the billable amount to invoice a merchant

amountnumber (double)

The amount charged for this transaction

transaction_typestring

The type of transaction

json
{
  "channel": {
    "id": 0,
    "name": "string"
  },
  "completed_date": "2025-01-01T00:00:00Z",
  "customer_name": "string",
  "fulfillment_center": {
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "insert_date": "2025-01-01T00:00:00Z",
  "inventory": [
    {
      "action_requested": {
        "action": "string",
        "action_type": "string",
        "instructions": "string"
      },
      "action_taken": [
        {
          "action": "string",
          "action_reason": "string",
          "image_url": "string",
          "quantity_processed": 0
        }
      ],
      "bundle_parent_sku": "string",
      "id": 0,
      "name": "string",
      "quantity": 0
    }
  ],
  "invoice_amount": 0,
  "original_shipment_id": 0,
  "reference_id": "string",
  "return_type": "string",
  "status": "string"
}

Need more? See the ShipBob guide for connection setup and behaviour shared by every action.

Was this page helpful?