Get Fulfillment Info

Retrieves an order’s fulfillment information specified by order ID.

GET /commerce/orders/{orderId}/fulfillmentinfo

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "data": {},
  "fulfillmentContact": {
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "addressType": "<string>",
      "cityOrTown": "<string>",
      "countryCode": "<string>",
      "isValidated": true,
      "postalOrZipCode": "<string>",
      "stateOrProvince": "<string>"
    },
    "companyOrOrganization": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "id": 123,
    "lastNameOrSurname": "<string>",
    "middleNameOrInitial": "<string>",
    "phoneNumbers": {
      "home": "<string>",
      "mobile": "<string>",
      "work": "<string>"
    }
  },
  "isDestinationCommercial": true,
  "shippingMethodCode": "<string>",
  "shippingMethodName": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId · string · required

Unique identifier of the order.

Query Parameters

draft · boolean

Determines whether the draft version should be retrieved if one exists.

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

auditInfo · object

Show child attributes

data · object

Custom data originated by the shipping service.

fulfillmentContact · object

Show child attributes

isDestinationCommercial · boolean | null

Indicates that the destination is commercial

shippingMethodCode · string | null

Code that uniquely identifies the shipping method such as "Ground," "Overnight," or "Digital." The site's shipping settings lists the valid shipping methods specified for this site.

shippingMethodName · string | null

Readable name of the shipping method