extensions / Commerce extension
POST
/api/projects/{project_id}/sales/orders/{order_id}/shipments/can-createCheck Shipment Availability
Evaluates whether a shipment can be created for an order in the target project.
POST
Authentication
- Requirement
- Required
- Credential type
- Bearer API key
- Scopes
- Not specified
Permissions
- Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.
Headers
| Name | Required | Type | Details |
|---|---|---|---|
Authorization | Yes | Not specified | Description: Bearer credential used to authenticate the request. |
Path Parameters
| Name | Required | Type | Details |
|---|---|---|---|
project_id | Yes | Not specified | Description: Target project identifier. |
order_id | Yes | Not specified | Description: Identifier for order. |
Query Parameters
Request Body
Schema: CanCreateShipmentRequest
| Field | Required | Type | Details |
|---|---|---|---|
shipment | No | CreateShipmentRequest | Description: Value used by this operation. |
is_admin_approved | No | boolean | Description: Boolean flag. |
is_stock_reserved | No | boolean | Description: Boolean flag. |
trigger | No | string | Description: Text value. |
Response Body
Example 200 response
json
{
"allowed": "string",
"reasons": [],
"warnings": []
}Errors
400 bad_request404 not_found500 internal_server_errorAvailability
- Available in
- v0.1.0
- Available since
- v0.1.0
- Implementation
- Available
- Deprecation
- Not specified
- Rate limits
- Not specified