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 three types of Orders.
Purchase - A purchase order is the first order created in the lifecycle of an agreement. The purchase order is always the first order, and there is only one within an agreement.
Change - A change order is a request to update the agreement. There can be multiple change orders in an agreement.
Termination - A termination order is a request to terminate the agreement or terminate a specific subscription within the agreement. There can be multiple termination orders.
The Order object contains the following properties:
id
string
Primary identifier for the order.
Example: ORD-5542-1187-3130-0991
href
string
Relative reference to the object in the API.
Example: /commerce/orders/ORD-5542-1187-3130-0991
type
string
The type of order. Specified when the order is created and cannot be updated.
Example: Purchase
status
string
Status of the order.
Example: Processing
externalIds
ExternalIds
External IDs for either 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
Message Object
Notes added during status change by the vendor or vendor extensions to indicate the reason for order failure or status change.
Example:
error
Message Object
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
Agreement
The agreement represents an instance of a relationship between the seller, buyer, and the licensee.
It may refer to one-time purchases or/and set of subscriptions.
Example:
authorization
Authorization
Reference to the Authorization object which was used for the order.
Example:
listing
Listing
Reference to the listing that was used for the order.
Example:
template
Template
Reference to the Template object.
Example:
assignee
User
Reference to the User object.
Example:
audit
AuditObject
Reference to the Audit object.
Example:
lines
Line
Order lines contain the information about the specific item the buyer is purchasing/updating.
Example:
parameters.fulfillment
Order Parameter Object
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
parameters.ordering
Order Parameter Object
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
subscriptions
Subscription
List of subscription references for subscriptions to be added or updated by the order.
Example:
price
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?