Skip to main content

OrdersApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
ordersControllerFetchStatusGET /v1/orders/{transaction_number}Get order status update
ordersControllerFindGET /v1/ordersGet customer order history
ordersControllerReorderGET /v1/orders/{order_id}/reorderGet re-order plan

ordersControllerFetchStatus

OrderPartialClass ordersControllerFetchStatus(transaction_number)

Get order status update

Parameters

NameTypeDescriptionNotes
transaction_numberString[default to null]

Return type

OrderPartialClass

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ordersControllerFind

OrderEntity ordersControllerFind(id, max_order_date, min_order_date, status, order_type, meal_plan, limit, offset)

Get customer order history

Parameters

NameTypeDescriptionNotes
idStringCustomer ID that you passed to us[default to null]
max_order_dateStringISO8601 compliant order date string[optional] [default to null]
min_order_dateStringISO8601 compliant order date string[optional] [default to null]
statusStringOrder status filter[optional] [default to null] [enum: new, out_for_delivery, accepted, ready, cancelled, completed, refunded, expired, payment_failed, payment_pending]
order_typeStringOrder type[optional] [default to null] [enum: delivery, pickup, third_party_pickup, curbside_pickup]
meal_planBooleanToggle meal plan filter, returns orders that are part of a meal plan ONLY if set to true Defaults to false[optional] [default to null]
limitBigDecimalThe number of record to return, 0 means all will be returned[optional] [default to null]
offsetBigDecimalThe number of records to skip[optional] [default to null]

Return type

OrderEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ordersControllerReorder

ReorderEntity ordersControllerReorder(order_id)

Get re-order plan

Parameters

NameTypeDescriptionNotes
order_idString[default to null]

Return type

ReorderEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json