For the complete documentation index, see llms.txt. This page is also available as Markdown.

8.7 Order Tracking

post

Start tracking 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
default

tracking information

application/json

Contains tracking information that can be used by the Consumer Interface to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.

idstringOptional

A unique tracking reference number

urlstring · uriOptional

A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the Consumer Interface where Provider Platform can push the tracking data, or a GET url creaed by the Provider Platform which the Consumer Interface can poll to get the tracking data. It can also be a websocket URL where the Provider Platform can push real-time tracking data.

statusstring · enumOptional

This value indicates if the tracking is currently active or not. If this value is active, then the Consumer Interface can begin tracking the order. If this value is inactive, the tracking URL is considered to be expired and the Consumer Interface should stop tracking the order.

Possible values:
post/tracking/start
default

tracking information

post

Start tracking 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
default

tracking information

application/json

Contains tracking information that can be used by the Consumer Interface to track the fulfillment of an order in real-time. which is useful for knowing the location of time sensitive deliveries.

idstringOptional

A unique tracking reference number

urlstring · uriOptional

A URL to the tracking endpoint. This can be a link to a tracking webpage, a webhook URL created by the Consumer Interface where Provider Platform can push the tracking data, or a GET url creaed by the Provider Platform which the Consumer Interface can poll to get the tracking data. It can also be a websocket URL where the Provider Platform can push real-time tracking data.

statusstring · enumOptional

This value indicates if the tracking is currently active or not. If this value is active, then the Consumer Interface can begin tracking the order. If this value is inactive, the tracking URL is considered to be expired and the Consumer Interface should stop tracking the order.

Possible values:
post/tracking/stop
default

tracking information

put

Update location during tracking

Path parameters
order_idstringRequired

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

The physical location of something

idstringOptional
map_urlstring · uriOptional

The url to the map of the location. This can be a globally recognized map url or the one specified by the network policy.

gpsstringOptional

Describes a GPS coordinate

Pattern: ^[-+]?([1-8]?\d(\.\d+)?|90(\.0+)?),\s*[-+]?(180(\.0+)?|((1[0-7]\d)|([1-9]?\d))(\.\d+)?)$
addressstringOptional

Describes a postal address.

districtstringOptional

The state this location is, or is located within

area_codestringOptional
polygonstringOptional

The boundary polygon of this location

3dspacestringOptional

The three dimensional region describing this location

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
default

Acknowledgement of message received after successful validation of schema and signature

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/tracking/{order_id}/update_location
default

Acknowledgement of message received after successful validation of schema and signature

Last updated

Was this helpful?