Orders
An order is a request made by a buyer to create/update an agreement with a one-time purchase or/and set of subscriptions. There are different types of orders in the Marketplace Platform:
Purchase orders - An order to buy a new product or service by establishing a new agreement.
Change orders - An order to change the quantity, such as downsizing the quantity of licenses or ordering additional licenses.
Terminate order - An order to terminate an active subscription or an agreement.
Configuration order - An order to enable or disable the auto-renewal of a subscription.
The Order object contains the following properties:
id
string
The primary identifier for the order.
Example: ORD-5542-1187-3130-0991
href
string
A relative reference to the object in the API.
Example: /commerce/orders/ORD-5542-1187-3130-0991
type
string
The type of order. The value is specified when the order is created and cannot be updated.
Example: Purchase
status
string
The status of the order.
Example: Processing
externalIds
External IDs for client/vendor/distributor.
Example:
notes
string
Contains initial customer notes added by the buyer during the purchase process. Buyers can edit and add notes at any time for all order statuses.
Example: Order of 2 subs for 2 ppl from the accounting dept.
statusNotes
Notes added during status change by the vendor or vendor extensions to indicate the reason for order failure or status change.
Example:
error
Standard error object. Means some error appeared on the parameters validation, which can include markup.
Used to indicate a validation error by the vendor or vendor extension during order validation.
Example:
agreement
A reference to the Agreement object.
Example:
authorization
A reference to the Authorization object, which was used for the order.
Example:
listing
A reference to the listing that was used for the order.
Example:
template
A reference to the Template object.
Example:
assignee
A reference to the User object.
Example:
audit
A reference to the Audit object.
Example:
lines
line
Contains information about the specific item that the buyer is purchasing/updating.
Example:
parameters.fulfillment
object
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
parameters.ordering
object
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
subscriptions
A list of references for subscriptions to be added or updated by the order.
Example:
price
Represents the total price for the order and is displayed to the various actors. The object is READONLY
.
Not all fields are visible to all actors.
Example:
Example
Last updated
Was this helpful?