Update an easypost pickup
How to update an existing easypost pickup via API
To update an existing easypost pickup, send a PATCH
request to the /api/easypost_pickups/:id
endpoint, where id
is the ID of the resource that you want to update.
Here below the list of all the possible arguments that you can pass with the request body.
Request
PATCH https://yourdomain.commercelayer.io/api/easypost_pickups/:id
Arguments
Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.selected_rate_id
string
Optional
attributes._purchase
boolean
Optional
relationships.shipment
object
Optional
Example
The following request updates the easypost pickup identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/easypost_pickups/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "easypost_pickups",
"id": "xYZkjABcde",
"attributes": {
"reference": "ANY-EXTERNAL-REFEFERNCE"
},
"relationships": {
"shipment": {
"data": {
"type": "shipments",
"id": "ABCRtyUpBa"
}
}
}
}
}'
Last updated