Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
BlanketOrder

Cancel a Blanket Order

Cancel a Blanket Order.

post/commerce/blanketorders/{blanketOrderId}/cancel

Path parameters

blanketOrderIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

descriptionstring nullable
moreInfostring nullable
reasonCodestring nullable

Response

OK

availableActionsstring[] nullable

Available lifecycle actions from the current status. Populated on read.

cancelledDatestring date-time nullable

Date when the order was cancelled. System-supplied, read-only.

channelCodestring nullable

Channel code for multi-channel context.

currencyCodestring nullable

Currency code (default "USD").

customerAccountIdinteger nullable
dataobject nullable

Extensibility data bag for tenant-specific custom data.

externalIdstring nullable

External reference identifier for integration with external systems.

idstring nullable
numberinteger nullable

Auto-generated sequential Blanket Order number. System-supplied, read-only.

priceListCodestring nullable

Price list code for pricing context.

siteIdinteger
statusstring nullable

Current status managed by the StatusEngine transition table.

tenantIdinteger
userIdstring nullable
versionstring nullable

Optimistic concurrency token. System-supplied.