githubEdit

8.6 Order Fulfillment

post

create fulfillment to order

Body

Details of customer support

order_idstringOptional
callback_phonestring · phoneOptional
Responses
chevron-right
default

Successful closure of a chat session

application/json

Details of customer support

order_idstringOptional
callback_phonestring · phoneOptional
post
/fulfillments
default

Successful closure of a chat session

get

create a fulfillment

Path parameters
fulfillmentIdstringRequired

Unique reference ID to the fulfillment of an order

Responses
chevron-right
default

Successful closure of a chat session

application/json

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.

get
/fulfillments/{fulfillmentId}
default

Successful closure of a chat session

put

Update fulfillment state for an order

Path parameters
fulfillmentIdstringRequired

Unique reference ID to the fulfillment of an order

Body

Describes the state of fulfillment

updated_atstring · date-timeOptional
updated_bystringOptional

ID of entity which changed the state

Responses
chevron-right
default

Successful closure of a chat session

application/json

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.

put
/fulfillments/{fulfillmentId}
default

Successful closure of a chat session

delete

Cancel the fulfillment for an order

Path parameters
fulfillmentIdstringRequired

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
chevron-right
default

Successful closure of a chat session

application/json

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.

delete
/fulfillments/{fulfillmentId}
default

Successful closure of a chat session

post

Check serviceability of 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
chevron-right
default

Serviceable

application/json
serviceablebooleanOptional
post
/fulfillment/checkServiceability
default

Serviceable

put

Add fulfillment to an order

Path parameters
fulfillmentIdstringRequired

Unique reference ID to the fulfillment of an order

Body

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

idstringOptional
ratingstringOptional

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 ||.

Responses
chevron-right
default

Order with allocated agent

application/json

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

put
/fulfillment/{fulfillmentId}/agent/allocate
default

Order with allocated agent

delete

Add fulfillment to an order

Path parameters
fulfillmentIdstringRequired

Unique reference ID to the fulfillment of an order

Responses
chevron-right
default

Order with agent deallocated

application/json

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

delete
/fulfillment/{fulfillmentId}/agent/deallocate
default

Order with agent deallocated

Last updated

Was this helpful?