Return created

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

ReturnSchema · object

required

Show child attributes

data.id

string

The unique ID of the return.

Example:

"return_id"

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the return. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

data.created_date

string<date-time>

The date the return was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the return was last updated.

Example:

"2022-01-02T05:05:05Z"

data.status

enum<string>

The status of the return. See the return information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

Example:

"open"

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

Example:

"raw_status"

data.order_id

string | null

The ID of the order that the return is associated with. Can be passed into the Order endpoint for more details.

Example:

"order_id"

data.notes

string[]

A list of notes associated with the return.

This is a note

Example:

["This is a note"]

data.line_items

WmsReturnLineItem · object[]

A list of inventory items included in the return.

Show child attributes

data.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

data.line_items.sku

string | null

required

Example:

"sku"

data.line_items.expected_quantity

integer

required

How many units are expected to arrive.

Example:

1

data.line_items.received_quantity

integer

required

How many units actually arrived.

Example:

1

data.line_items.restocked_quantity

integer | null

required

The number of returned inventory items that have been restocked.

Example:

1

data.line_items.return_reason

string | null

required

The reason for the return.

Example:

"Too Small"

data.line_items.quantity

integer

required

This field is deprecated in favor of more detailed fields.

Example:

0

data.line_items.warehouse_id

string | null

required

This field is deprecated in favor warehouse_id within the shipments.

Example:

"deprecated"

data.line_items.returned_date

string<date-time> | null

required

This field is deprecated in favor of the shipped_date and arrived_date within the shipments.

Example:

"deprecated"

Example:

[
  {
    "inventory_item_id": "item_id",
    "sku": "sku",
    "expected_quantity": 1,
    "received_quantity": 1,
    "restocked_quantity": 1,
    "return_reason": "Too Small",
    "quantity": 0,
    "warehouse_id": "deprecated",
    "returned_date": "deprecated"
  }
]

data.shipments

ReturnShipment · object[]

List of the shipments associated with the return.

Show child attributes

data.shipments.tracking_number

string | null

required

The tracking number of the shipment.

data.shipments.shipped_date

string<date-time> | null

required

The date the shipment was sent.

data.shipments.arrived_date

string<date-time> | null

required

The date the shipment arrived.

data.shipments.warehouse_id

string | null

required

The ID of the warehouse the shipment was sent to. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id"

data.shipments.carrier

string | null

required

The carrier of the shipment. Use carrier_id instead.

data.shipments.carrier_id

string | null

required

The ID of the carrier for the shipment.

Example:

"carrier_id"

data.shipments.carrier_name

string | null

required

The name of the carrier for the shipment.

Example:

"carrier_name"

data.shipments.scac

string | null

required

The Standard Carrier Alpha Code (SCAC) for the shipment.

Example:

"FDXG"

data.shipments.shipping_cost

number | null

required

The cost of the shipment.

Example:

0

data.shipments.measurements

ShipmentMeasurements · object

required

Show child attributes

data.shipments.measurements.length

number | null

required

Example:

1.5

data.shipments.measurements.width

number | null

required

Example:

1.5

data.shipments.measurements.height

number | null

required

Example:

1.5

data.shipments.measurements.unit

enum<string> | null

required

The unit of measurement for the size of the shipment.

Available options:

cm,

in

Example:

"in"

data.shipments.measurements.weight

number | null

required

Example:

2.5

data.shipments.measurements.weight_unit

enum<string> | null

required

The unit of measurement for the weight of the shipment.

Available options:

kg,

oz,

lb

Example:

"lb"

data.shipments.line_items

ReturnShipmentLineItem · object[]

required

List of inventory items items in the shipment.

Show child attributes

data.shipments.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

data.shipments.line_items.sku

string | null

required

Example:

"sku"

data.shipments.line_items.quantity

integer

required

How many units were shipped.

Example:

1

data.shipments.line_items.receiving_details

ReceivingDetails · object[]

required

Details about received items in the shipment.

Show child attributes

data.shipments.line_items.receiving_details.quantity

integer

required

How many units were received in this condition and disposition.

Example:

1

data.shipments.line_items.receiving_details.condition

string | null

required

The condition of the item received.

Example:

"good"

data.shipments.line_items.receiving_details.disposition

string | null

required

The disposition of the item received, eg restocked or discarded.

Example:

"restocked"

Example:

[
  {
    "quantity": 1,
    "condition": "good",
    "disposition": "restocked"
  }
]

Example:

[
  {
    "tracking_number": "tracking_number",
    "shipped_date": "2023-02-03T02:04:06Z",
    "arrived_date": "2023-02-03T02:04:06Z",
    "warehouse_id": "warehouse_id",
    "carrier": "carrier",
    "carrier_id": "carrier_id",
    "carrier_name": "carrier_name",
    "scac": "FDXG",
    "shipping_cost": 1.23,
    "measurements": {
      "length": 1,
      "width": 1,
      "height": 1,
      "unit": "in",
      "weight": 1,
      "weight_unit": "lb"
    },
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "quantity": 4,
        "receiving_details": [
          {
            "quantity": 1,
            "condition": "good",
            "disposition": "restocked"
          },
          {
            "quantity": 1,
            "condition": "damaged",
            "disposition": "scrapped"
          }
        ]
      }
    ]
  }
]

data.external_system_url

string | null

URL link to the return in the external system (WMS/Freight etc).

Example:

"https://example.com/return/123"

data.trackstar_tags

any[] | null

A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.

Example:

["tag1", "tag2", { "tag3": "value3" }]

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"return.created"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

Response

200

Success

Home

How-To Guides

Use Cases

Body

Response