Update pickup information of an order

Updates pickup information of a specific order by order ID.

PATCH /order/{orderId}/shipto/{shipToId}/pickup

Update pickup information of an order

cURL

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": "[e-mail]",
  "phone": {
    "number": "55555555555",
    "type": "MOBILE"
  },
  "pickupType": "Primary"
}
'

200

{
  "shipToId": "5349b4ddd2781d08c09890f4",
  "taxCode": "FR01",
  "locationNum": "123",
  "pickup": [
    {
      "name": {
        "first": "John",
        "middle": "Middle",
        "last": "Doe"
      },
      "email": "[e-mail]",
      "phone": {
        "number": "55555555555",
        "type": "MOBILE"
      },
      "pickupType": "Primary"
    }
  ],
  "shipToAddress": {
    "address1": "First line of address",
    "name": {
      "first": "John",
      "middle": "Middle",
      "last": "Doe"
    },
    "email": "[e-mail]",
    "phone": {
      "number": "55555555555",
      "type": "MOBILE"
    },
    "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

name · object

Name for order details

Show child attributes

email · string

Example:

"[e-mail]"

phone · object

Contact details of customer for the order

Show child attributes

pickupType · enum<string>

Available options: Primary, Alternate

Example:

"Primary"

Response

200

application/json

Pickup information updated

Order shipping info

shipToId · string · required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

taxCode · string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

locationNum · string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

pickup · object[]

Show child attributes

shipToAddress · object

Order billing or shipping address

Show child attributes

taxDetail · object[]

Show child attributes

shipMethod · string

Example:

"Express Delivery"

shipToType · string

Example:

"SHIP_TO_ADDRESS"

estimatedShipDate · string<date-time>

Example:

"2022-05-12T09:30:31.198Z"

estimatedDeliveryDate · string<date-time>

Example:

"2022-05-12T09:30:31.198Z"

shipToPrice · number

Amount applicable for shipping the item to the address

Example:

20

shipToDiscount · number

Discount amount applied for shipping the item to the address

Example:

12.6

shipToTaxTotal · number

Total tax applicable to ship the item to the address

Example:

12.6

shipmentInstructions · string

Additional user instructions

Example:

"User instructions"

attributes · object

Show child attributes

Example:

{ "isOpenBox": false, "isOTPDElivery": true }