younifyd
Menu

Get 2026 07 Return Id

Get Return Order

GET/2026-07/return/{id}

Use it in a workflow

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

Request

Path parameters

idinteger (int32)required

The Id of the Return

Headers

shipbob_channel_idinteger (int32)

Channel Id for Operation

Response

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

arrived_datestring (date-time)

The date and time when the return arrived at the fulfillment center

awaiting_arrival_datestring (date-time)

The date and time when the return entered Awaiting Arrival status

cancelled_datestring (date-time)

The date and time when the return was cancelled, if applicable

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

barcodesarray<string>

List of barcodes associated with the inventory item

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

lot_informationobject3 fields

Lot information associated with a specific inventory item.

namestring

Name of the product

quantityinteger (int32)

Number of inventory that is being returned

skustring

Stock keeping unit identifier for the inventory item

invoiceobject

The invoice amount and curency

amountnumber (double)

Amount being charged

currency_codestring

Currency code of amount

original_shipment_idinteger (int32)

ShipmentId for which return was created

processing_datestring (date-time)

The date and time when the return started processing

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

shipment_tracking_numberstring

The tracking number of the original shipment

statusstring

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

status_historyarray<object>

List of status history in return order

statusstring

Status to change

timestampstring (date-time)

Date change status

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
{
  "arrived_date": "2025-01-01T00:00:00Z",
  "awaiting_arrival_date": "2025-01-01T00:00:00Z",
  "cancelled_date": "2025-01-01T00:00:00Z",
  "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
        }
      ],
      "barcodes": [
        "string"
      ],
      "bundle_parent_sku": "string",
      "id": 0,
      "lot_information": {
        "expiration": "2025-01-01T00:00:00Z",
        "minimumShelfLife": 0,
        "number": "string"
      },
      "name": "string",
      "quantity": 0,
      "sku": "string"
    }
  ],
  "invoice": {
    "amount": 0,
    "currency_code": "string"
  },
  "original_shipment_id": 0
}

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