Update pickup information of an order

We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

Update pickup information of an order

Updates pickup information of a specific order by order ID.

Request

path Parameters

orderId required	string Example: b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569
shipToId required	string Example: 5349b4ddd2781d08c09890f4

header Parameters

required

object

x-site-context value

Request Body schema: application/json

	object Name for order details
email	string
	object Contact details of customer for the order
pickupType	string Enum: "Primary" "Alternate"

Responses

200

Pickup information updated

400

Bad request

404

Order not found

500

Internal server error

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

Request samples

Payload

application/json

{"name": {"first": "John",
"middle": "Middle",
"last": "Doe"
},
"email": "john123@gmail.com",
"phone": {"number": "55555555555",
"type": "MOBILE"
},
"pickupType": "Primary"
}

Response samples

application/json

{"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
}
}