8.5 Order Management

post

Fetch order history

Body

Describes a legal purchase order. It contains the complete details of the legal contract created between the buyer and the seller.

idstringOptional

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

ref_order_idsstring[]Optional

A list of order IDs to link this order to previous orders.

statusstring · enumOptional

Status of the order. Allowed values can be defined by the network policy

Possible values:
typestring · enumOptional

This is used to indicate the type of order being created to Provider Platforms. Sometimes orders can be linked to previous orders, like a replacement order in a retail domain. A follow-up consultation in healthcare domain. A single order part of a subscription order. The list of order types can be standardized at the network level.

Default: DEFAULTPossible values:
created_atstring · date-timeOptional

The date-time of creation of this order

updated_atstring · date-timeOptional

The date-time of updated of this order

Responses
post
/orders
default

Acknowledgement of message received after successful validation of schema and signature

get

Fetch an order

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Responses
get
/orders/{orderId}
default

Updated order object

put

Fetch order history

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body

Describes the terms of settlement between the Consumer Interface and the Provider Platform for a single transaction. When instantiated, this object contains the amount that has to be settled,The payment destination destination detailsWhen the settlement should happen, andA transaction reference ID. During a transaction, the Provider Platform reserves the right to decide the terms of payment. However, the Consumer Interface can send its terms to the Provider Platform first. If the Provider Platform does not agree to those terms, it must overwrite the terms and return them to the Consumer Interface. If overridden, the Consumer Interface must either agree to the terms sent by the Provider Platform in order to preserve the provider's autonomy, or abort the transaction. In case of such disagreements, the Consumer Interface and the Provider Platform can perform offline negotiations on the payment terms. Once an agreement is reached, the Consumer Interface and Provider Platform can resume transactions.

idstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

collected_byanyOptional

This field indicates who is the collector of payment. The Consumer Interface can set this value to 'Consumer Interface' if it wants to collect the payment first and settle it to the Provider Platform. If the Provider Platform agrees to those terms, the Provider Platform should not send the payment url. Alternatively, the Provider Platform can set this field with the value 'Provider Platform' if it wants the payment to be made directly.

urlstring · uriOptional

A payment url to be called by the Consumer Interface. If empty, then the payment is to be done offline. The details of payment should be present in the params object. If tl_method = http/get, then the payment details will be sent as url params. Two url param values, $transaction_id and $amount are mandatory.

typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
Responses
put
/orders/{orderId}/updatePayment
default

Acknowledgement of message received after successful validation of schema and signature

put

Fetch order history

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body

Describes how a an order will be rendered/fulfilled to the end-customer

idstringOptional

Unique reference ID to the fulfillment of an order

typestringOptional

A code that describes the mode of fulfillment. This is typically set when there are multiple ways an order can be fulfilled. For example, a retail order can be fulfilled either via store pickup or a home delivery. Similarly, a medical consultation can be provided either in-person or via tele-consultation. The network policy must publish standard fulfillment type codes for the different modes of fulfillment.

rateablebooleanOptional

Whether the fulfillment can be rated or not

ratingall ofOptional

The rating value of the fulfullment service.

stringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

trackingbooleanOptional

Indicates whether the fulfillment allows tracking

Default: false
pathstringOptional

The physical path taken by the agent that can be rendered on a map. The allowed format of this property can be set by the network.

Responses
put
/orders/{orderId}/updateFulfillment
default

Acknowledgement of message received after successful validation of schema and signature

put

Fetch order history

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body

Describes the billing details of an entity.This has properties like name,organization,address,email,phone,time,tax_number, created_at,updated_at

namestringOptional

Name of the billable entity

addressall ofOptional

The address of the billable entity

stringOptional

Describes a postal address.

emailstring · emailOptional

Email address where the bill is sent to

phonestringOptional

Phone number of the billable entity

tax_idstringOptional

ID of the billable entity as recognized by the taxation authority

Responses
put
/orders/{orderId}/updateBilling
default

Acknowledgement of message received after successful validation of schema and signature

put

Fetch order history

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body
Responses
put
/orders/{orderId}/updateItems
default

Acknowledgement of message received after successful validation of schema and signature

put

Fetch order history

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body
Responses
put
/orders/{orderId}/updateAddOns
default

Acknowledgement of message received after successful validation of schema and signature

put

Cancel order

Path parameters
orderIdstringRequired

Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.

Body

Return cancelled order

Responses
put
/orders/{orderId}/cancel
default

Acknowledgement of message received after successful validation of schema and signature

Last updated

Was this helpful?