Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillment Returns

Creates a return

Returns all or part of a previously created fulfillment order.

post/fulfillment-returns

Request body

fulfillmentOrderIdstring required

The unique identifier of the fulfillment order associated with the fulfillment return.

upstreamIdstring

The unique identifier of the upstream order.

reasonstring

The reason for the return.

Example request

{
  "fulfillmentOrderId": "6645940010",
  "upstreamId": "6645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "quantity": 1,
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ]
}

Response

201 Created

idstring

The unique identifier for the fulfillment return.

createdTimestring date-time

The time when the fulfillment return was created.

fulfillmentOrderIdstring

The unique identifier of the fulfillment order associated with the fulfillment return.

upstreamIdstring

The unique identifier of the upstream order.

reasonstring

The reason for the return.

state'created' | 'pending' | 'accepted' | 'rejected'

An enumeration indicating the state of the fulfillment return.

type'client' | 'warehouse'

An enumeration indicating the type of the fulfillment return.

livemodeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted",
      "location": {
        "address": {
          "line1": "10380 Bren Rd W",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "name": "John Smith",
        "phone": "952-111-1111",
        "email": "jsmith@digitalriver.com"
      },
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ],
      "unitAttributesAccepted": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "type": "client",
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "jsmith@digitalriver.com"
  }
}