GET an order

GET api.foodin.ai/users/{user_id}/orders/{order_id}

Retrieves order details by order ID. Order details include the status, creation time, time slot, and the Items object. For orders that have been fulfilled, the response includes the location of the fulfillment store, how many bags were in the order, and when the customer received their order.

Request

Parameters

Field	Type	Description
user_id	string	The ID of the user.
order_id	string	The ID of the order.

Request example

const axios = require("axios");
 
const user_id = "...";
const order_id = "...";
const token = "...";
 
axios({
  method: "get",
  url: `https://api.foodin.ai/users/${user_id}/orders/${order_id}`,
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
})
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Request Parameters

Field	Type	Description
id	string	The ID of the order.
status	string	The current order status.
order_url	string	Link to view the order.
created_at	string	The time of order creation in ISO 8601 format.
cancellation_reason	string	The reason the order was canceled.
locale	string	The order's locale in POSIX format. Example: en_US.
fulfillment_details	Object	The order delivery details.
warnings	Array	Any warnings associated with this request.
items	Array	The items in the order.
pos_payment_method	string	The point of sale payment method. The values are UNSPECIFIED (method not set or nil), UNKNOWN (method is not known), MARQETA (Marqeta credit or debit card was used), or BYPASS (custom option was used).

Fulfillment_details

Field	Type	Description
store_location	string	The location code of the store where the order was fulfilled. The store_location is often the same as the location_code that was used to create the order. However, orders can be fulfilled from a different store location.
window_starts_at	string	The start time of the delivery window in ISO 8601 format.
window_ends_at	string	The end time of the delivery window in ISO 8601 format.
delivered_at	string	The time the order was delivered in ISO 8601 format.
bag_count	integer	The number of bags in the order.
handoff_window_starts_at	string	The start time of the handoff window in ISO 8601 format.
handoff_window_ends_at	string	The end time of the handoff window in ISO 8601 format.

Warnings Object

Field	Type	Description
error	Object	Information relevant to the error.

|meta|Object|The error metadata.|

Meta Object

Field	Type	Description
items	Array	The items that triggered the error.

Items Object

Field	Type	Description
item_code	string	The store reference code (RRC) or universal product code (UPC) of an item that triggered the error.

Items Object

Field	Type	Description
line_num	string	The item's line number in the order.
qty	number	The quantity of the item.
qty_unit	string	The quantity type, either "each" or "kg".
qty_fulfilled	number	The fulfilled quantity of the item.
qty_fulfilled_unit	string	The fulfilled quantity type, either "each" or "kg".
qty_requested	number	The initally requested quantity of the item.
qty_requested_unit	string	The initally requested quantity type, either "each" or "kg".
replaced	boolean	Indicates whether the item was replaced.
scan_code	string	The scan code of the item.
replacement_policy	string	The replacement policy for the item.
deliverer_provided_item_name	string	The item name provided by deliverers for items that they added.
deliverer_provided_item_price	Object	The item price provided by deliverers for items that they added.
item	Object	The item's codes.

Deliverer_provided_item_price Object

Field	Type	Description
amount	number	The amount of a specified currency.
currency	string	The currency type in ISO 4217 format. For example: USD.

Item Object

Field	Type	Description
upc	string	The item's universal product code (UPC).
rrc	string	The item's store reference code (RRC).
requested_upc	string	The requested item's universal product code (UPC).
requested_rrc	string	The requested item's store reference code (RRC).
delivered_upc	string	The delivered item's universal product code (UPC).
delivered_rrc	string	The delivered item's store reference code (RRC).

Response

Order found

{
  "id": "12345676789012345678780",
  "status": "created",
  "order_url": "https://foodin.ai/example_store/example-order",
  "created_at": "2022-02-22T00:00:00Z",
  "cancellation_reason": "delivery_driven",
  "locale": "en_US",
  "fulfillment_details": {
    "store_location": "000-31182",
    "window_starts_at": "2018-02-22T00:00:00Z",
    "window_ends_at": "2018-02-22T00:30:00Z",
    "bag_count": 3
  },
  "items": [
    {
      "line_num": "56",
      "qty": 11,
      "qty_unit": "each",
      "qty_fulfilled": 25,
      "qty_fulfilled_unit": "lb",
      "qty_requested": 20,
      "qty_requested_unit": "lb",
      "replaced": false,
      "scan_code": "00070481001167",
      "replacement_policy": "shoppers_choice",
      "item": {
        "upc": "987665788999",
        "rrc": "0452-38492",
        "requested_upc": "123456789012",
        "requested_rrc": "0382-85739",
        "delivered_upc": "987665788999",
        "delivered_rrc": "0452-38492"
      }
    }
  ],
  "pos_payment_method": "UNSPECIFIED"
}

4XX Errors

Code	Cause	Error Message
400	Invalid user id	"User Not Found"
403	Inactive user	"User Not Active"
404	Order not found	"Resource not found"

Create Direct Order Update Order