Requires write_product access scope. More access scope
The Delete CarrierService API allows users to remove an existing carrier service. This operation can occur either when the application actively requests deletion of the carrier service or when a merchant uninstalls a shipping-related application, ensuring the associated carrier services are also deleted to prevent users from using outdated shipping configurations.
This API is especially useful for:
Proactively removing carrier services that are no longer required.
Ensuring accurate shipping calculations when an application is uninstalled.
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!
