Update a shipping weight tier How to update an existing shipping weight tier via API
To update an existing shipping weight tier, send a PATCH
request to the /api/shipping_weight_tiers/: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/shipping_weight_tiers/:id
Arguments
Body Parameter Type Required attributes.price_amount_cents
attributes.reference_origin
relationships.shipping_method
Example
Request Response
The following request updates the shipping weight tier identified by the ID "xYZkjABcde":
Copy curl - g - X PATCH \
'https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde' \
- H 'Accept: application/vnd.api+json' \
- H 'Authorization: Bearer your-access-token' \
- H 'Content-Type: application/vnd.api+json' \
- d '{
"data" : {
"type" : "shipping_weight_tiers" ,
"id" : "xYZkjABcde" ,
"attributes" : {
"up_to" : 20.5
} ,
"relationships" : {
"shipping_method" : {
"data" : {
"type" : "shipping_methods" ,
"id" : "ABCRtyUpBa"
}
}
}
}
} '
On success, the API responds with a 200 OK
status code, returning the updated resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "shipping_weight_tiers" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde"
} ,
"attributes" : {
"name" : "Light shipping under 3kg" ,
"up_to" : 20.5 ,
"price_amount_cents" : 1000 ,
"price_amount_float" : 10.0 ,
"formatted_price_amount" : "€10,00" ,
"created_at" : "2018-01-01T12:00:00.000Z" ,
"updated_at" : "2018-01-01T12:00:00.000Z" ,
"reference" : "ANY-EXTERNAL-REFEFERNCE" ,
"reference_origin" : "ANY-EXTERNAL-REFEFERNCE-ORIGIN" ,
"metadata" : {
"foo" : "bar"
}
} ,
"relationships" : {
"shipping_method" : {
"links" : {
"self": "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/relationships/shipping_method",
"related" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/shipping_method"
}
} ,
"attachments" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/relationships/attachments" ,
"related" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/attachments"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/shipping_weight_tiers/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}
Last updated 7 months ago