Requires write_product access scope. More access scope
The Update CarrierService API allows users to update the details of an existing carrier service. This enables modifying specific attributes such as the carrier's active status, callback URL, and other properties.
This API is especially useful for:
Updating carrier service configurations when details change.
Modifying carrier service status (e.g., enabling or disabling).
Timestamp of when the carrier service was created.
carrier_service.update_at
string
"2024-07-02"
Timestamp of the last update to the carrier service.
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "invalid line_item id"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
