Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
order.events

aid_orders_id_events_post

Create a new order event

scopes:

  • admin:shopping
  • write:shopping
  • write:shopping:/orders/ANY/events
post/accounts/{aid}/shopping/orders/{order_id}/events

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

order_idstring required

The resource identifier string

Request body

state'error' | 'failure' | 'success' | 'pending' required

The state of the event

descriptionstring

A short description of the reason for the status

servicestring required

The type of service used, used to differentiate this status from other services

service_statusstring required

The status reported by the service

metadataobject

Additional service data related to the event

Example request

{
  "description": "food prepared",
  "service_status": "ready_for_pickup",
  "metadata": {
    "pickup_location": {
      "latitude": 37.42242,
      "longitude": -122.08585,
      "postal_code": "0342",
      "address": "Smallwei"
    }
  }
}

Response

event

event_type'service-event' required

The type corresponding to this event

idstring

The resource ID. Defaults to UUID v4

created_atstring date-time

Read-only timestamp, automatically assigned on back-end.

created_bystring

The resource ID. Defaults to UUID v4

state'error' | 'failure' | 'success' | 'pending' required

The state of the event

descriptionstring

A short description of the reason for the status

servicestring required

The type of service used, used to differentiate this status from other services

service_statusstring required

The status reported by the service

metadataobject

Additional service data related to the event

Example response

{
  "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "description": "food prepared",
  "service_status": "ready_for_pickup",
  "metadata": {
    "pickup_location": {
      "latitude": 37.42242,
      "longitude": -122.08585,
      "postal_code": "0342",
      "address": "Smallwei"
    }
  }
}