PATCH
/
order
/
{orderId}
/
shipto
/
{shipToId}
/
pickup
curl --request PATCH \
  --url https://prod01.oms.fabric.inc/api/v2/order/{orderId}/shipto/{shipToId}/pickup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "name": {
    "first": "John",
    "middle": "Middle",
    "last": "Doe"
  },
  "email": "john123@gmail.com",
  "phone": {
    "number": "55555555555",
    "type": "MOBILE"
  },
  "pickupType": "Primary"
}'
{
  "shipToId": "5349b4ddd2781d08c09890f4",
  "taxCode": "FR01",
  "locationNum": "123",
  "pickup": [
    {
      "name": {
        "first": "John",
        "middle": "Middle",
        "last": "Doe"
      },
      "email": "john123@gmail.com",
      "phone": {
        "number": "55555555555",
        "type": "MOBILE"
      },
      "pickupType": "Primary"
    }
  ],
  "shipToAddress": {
    "name": {
      "first": "John",
      "middle": "Middle",
      "last": "Doe"
    },
    "email": "john123@gmail.com",
    "phone": {
      "number": "55555555555",
      "type": "MOBILE"
    },
    "address1": "First line of address",
    "address2": "123 Parking Lot",
    "address3": "Third line of address",
    "address4": "Fourth line of address",
    "city": "Beaumont",
    "state": "TX",
    "country": "USA",
    "postalCode": "77705",
    "type": "residence",
    "latitude": 35.294952,
    "longitude": 32.294952
  },
  "taxDetail": [
    {
      "type": "tax",
      "value": 34.56
    }
  ],
  "shipMethod": "Express Delivery",
  "shipToType": "SHIP_TO_ADDRESS",
  "estimatedShipDate": "2022-05-12T09:30:31.198Z",
  "estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
  "shipToPrice": 20,
  "shipToDiscount": 12.6,
  "shipToTaxTotal": 12.6,
  "shipmentInstructions": "User instructions",
  "attributes": {
    "isOpenBox": false,
    "isOTPDElivery": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
orderId
string
required
Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

​
shipToId
string
required
Example:

"5349b4ddd2781d08c09890f4"

Body

application/json

Details of the person who picks up the order

Response

200
application/json

Pickup information updated

Order shipping info