8.4 Order Terms Management

post

Generate payment terms for an order

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
/terms/payment
default

Successful fetch of payment terms

post

Generate fulfillment terms for an order

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
/terms/fulfillment
default

Successful fetch of fulfillment terms

post

Generate cancellation terms for an order

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
/terms/cancellation
default

Successful fetch of cancellation terms

Last updated

Was this helpful?