post https://{subdomain}.myshoplaza.com/openapi/2024-07/orders//fulfillments//cancel
Cancels a specific fulfillment for an order. This action marks the fulfillment as canceled, stopping any further processing or shipping operations
Requires
write_orderaccess scope. More access scope
The Cancel Fulfillment API cancels a specific fulfillment for an order. This action marks the fulfillment as canceled, stopping any further processing or shipping operations
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | Order's unique identifier | "ORD_123456" |
fulfillment_id | string | Yes | Fulfillment's unique identifier | "FUL_123456" |
Response Description
Public Response Fields
Success Response
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
code | string | Yes | Status code (e.g., "success") | "success" |
message | string | Yes | Human-readable message | "Fulfillment created" |
data | object | Yes | {} |
Error Response
| Field | Type | Description | Example |
|---|---|---|---|
code | string | The error code indicating the type of issue. | InvalidParameter |
message | string | A detailed message describing the error. | Order id is required. |
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 |