Create Operation
Service that creates an operation and returns its identifier together with its expiration.
The operationId returned is the one sent to the store an asset and the first segment of every asset key.
Endpoint
POST /operationHeaders
consumer-id
string
Yes
Consumer identifier.
Request body
The body is optional: a request without a body also creates the operation.
Parameters
merchantReference
string
No
Own reference for this operation: the order, case, or cart it corresponds to. Maximum 128 characters.
Request example
{
"merchantReference": "ORD-4417"
}It is stored without leading or trailing spaces, and a blank reference is equivalent to sending none.
Responses
201 Created
Response parameters
operationId
string
Operation identifier (UUID).
timestamp
string
Creation time in format ISO 8601 (UTC).
expiresAt
string
Expiration time in format ISO 8601 (UTC).
merchantReference
string
The reference sent, returned as-is. It does not appear if none was sent.
Response example
Other responses
400
merchantReference more than 128 characters, or malformed body.
401
Missing, invalid, or expired Token.
403
The consumer is not provisioned with the service OPERATION.
429
The consumer has exceeded its request rate limit. The response includes Retry-After with the wait seconds, and X-RateLimit-Limit and X-RateLimit-Burst with the current thresholds.
503
The service is temporarily unavailable.
The body of an error response has the form described in MIDAPI v2.
Last updated