Skip to main content
GET
/
commerce
/
returns
/
{returnId}
/
packages
/
{packageId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "code": "<string>",
  "status": "<string>",
  "items": [
    {
      "productCode": "<string>",
      "quantity": 123,
      "fulfillmentItemType": "<string>",
      "lineId": 123,
      "optionAttributeFQN": "<string>"
    }
  ],
  "fulfillmentDate": "2023-11-07T05:31:56Z",
  "fulfillmentLocationCode": "<string>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "availableActions": [
    "<string>"
  ],
  "changeMessages": [
    {
      "id": "<string>",
      "correlationId": "<string>",
      "userId": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "subjectType": "<string>",
      "success": true,
      "identifier": "<string>",
      "subject": "<string>",
      "verb": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "oldValue": "<string>",
      "newValue": "<string>",
      "amount": 123,
      "createDate": "2023-11-07T05:31:56Z",
      "attributes": {}
    }
  ],
  "shippingMethodCode": "<string>",
  "shippingMethodName": "<string>",
  "shipmentId": "<string>",
  "trackingNumber": "<string>",
  "trackingNumbers": [
    "<string>"
  ],
  "packagingType": "<string>",
  "hasLabel": true,
  "measurements": {
    "height": {
      "unit": "<string>",
      "value": 123
    },
    "width": {
      "unit": "<string>",
      "value": 123
    },
    "length": {
      "unit": "<string>",
      "value": 123
    },
    "weight": {
      "unit": "<string>",
      "value": 123
    }
  },
  "carrier": "<string>",
  "signatureRequired": true,
  "trackings": [
    {
      "attributes": {},
      "number": "<string>",
      "url": "<string>"
    }
  ],
  "packingSlipItemDetails": [
    {
      "attributes": {},
      "lineId": 123,
      "originalOrderItemId": "<string>",
      "quantity": 123
    }
  ],
  "packingSlipNumber": 123,
  "returnTrackings": [
    {
      "attributes": {},
      "number": "<string>",
      "url": "<string>"
    }
  ],
  "returnTrackingNumbers": [
    "<string>"
  ],
  "returnCarrier": "<string>",
  "packageId": "<string>",
  "manifestId": "<string>",
  "labelFormat": "<string>",
  "integratorId": "<string>",
  "fxcbPackNotificationId": "<string>",
  "fxcbDocumentsUrl": "<string>",
  "attributes": {}
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
returnId
string
required

Unique identifier of the return with which to associate the package.

​
packageId
string
required

Package to remove from the return

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Describes a package that will be shipped to somebody

​
id
string | null

ID of the fulfillment unit.

​
code
string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form {fulfillmentUnitType} #{next available int}

​
status
string | null

Status of the fulfillment unit See FulfillmentStatusConst

​
items
object[] | null

List of items in the fulfillment unit

​
fulfillmentDate
string<date-time> | null

Date of the pickup

​
fulfillmentLocationCode
string | null

Location code from which to obtain this item

​
auditInfo
object
​
availableActions
string[] | null

Actions that can be taken on this fulfillment unit

​
changeMessages
object[] | null

Change messages related to the fulfillment unit.

​
shippingMethodCode
string | null

Code describing the shipping method.

​
shippingMethodName
string | null

Name of the shipping method

​
shipmentId
string | null

ID of the related shipment

​
trackingNumber
string | null

Tracking number of this package (to support classic use cases)

​
trackingNumbers
string[] | null

Tracking number of this package

​
packagingType
string | null

Packaging type of this package

​
hasLabel
boolean

If there is a shipping label present for this Package, this will be set to true

​
measurements
object

Physical dimensions of the package required to ship the product and its weight.

​
carrier
string | null

Carrier of this package

​
signatureRequired
boolean | null

SignatureRequired for this package

​
trackings
object[] | null

Tracking number and url data for this package

​
packingSlipItemDetails
object[] | null

PackingSlipItemDetails for this package

​
packingSlipNumber
integer<int32> | null

PackingSlipNumber for this package

​
returnTrackings
object[] | null
​
returnTrackingNumbers
string[] | null
​
returnCarrier
string | null
​
packageId
string | null
​
manifestId
string | null
​
labelFormat
string | null
​
integratorId
string | null
​
fxcbPackNotificationId
string | null
​
fxcbDocumentsUrl
string | null
​
attributes
object