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

gpsall ofOptional

The GPS co-ordinates of this location.

stringOptional

Describes a GPS coordinate

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

The address of this location.

stringOptional

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

ratingall ofOptional

The rating of this location

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

Responses
default

Acknowledgement of message received after successful validation of schema and signature

application/json
put
/tracking/{order_id}/update_location
default

Acknowledgement of message received after successful validation of schema and signature

Last updated

Was this helpful?