Skip to main content
GET
/
v1
/
orders
/
{id}
Get order details
curl --request GET \
  --url http://localhost:3000/v1/orders/{id}
{
  "order": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_number": "<string>",
    "status": "<string>",
    "total_amount": 123,
    "payment_status": "<string>",
    "payment_method": "<string>",
    "order_cutoff_time": "<string>",
    "estimated_pickup_time": "<string>",
    "actual_pickup_time": "<string>",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "notes": "<string>",
    "source": "<string>",
    "currency_code": "<string>",
    "email": "<string>",
    "fulfillment_status": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    },
    "location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "address_1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>"
    },
    "display_id": 123,
    "deleted_at": "<string>"
  },
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sellable_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "unit_price": 123,
      "fulfilled_quantity": 123,
      "shipped_quantity": 123,
      "fulfillment_source": "<string>",
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "brand": "<string>",
        "image_url": "<string>"
      },
      "source": "sweep",
      "picked_quantity": 123,
      "sweep_item": {
        "sweep_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "picked_quantity": 123,
        "status": "<string>",
        "sweep": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sweep_number": "<string>",
          "status": "<string>",
          "sweep_date": "<string>",
          "scheduled_start_time": "<string>",
          "retailer_name": "<string>",
          "location_name": "<string>",
          "total_items": 123,
          "picked_items": 123
        }
      },
      "pick_list_item": {
        "pick_list_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "pick_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "picked_quantity": 123,
        "status": "<string>",
        "location_code": "<string>",
        "pick_list": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "picker_name": "<string>"
        }
      },
      "location": {
        "bag_code": "<string>",
        "tote_code": "<string>",
        "cart_label": "<string>",
        "awaiting": "<string>"
      }
    }
  ],
  "fulfillment": {
    "bags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bag_code": "<string>",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tote_id": "<string>",
        "status": "<string>"
      }
    ],
    "totes": [
      {
        "id": "<string>",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>"
      }
    ]
  },
  "sweeps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sweep_number": "<string>",
      "status": "<string>",
      "sweep_date": "<string>",
      "scheduled_start_time": "<string>",
      "retailer_name": "<string>",
      "location_name": "<string>",
      "total_items": 123,
      "picked_items": 123,
      "order_item_count": 123,
      "order_subtotal": 123
    }
  ],
  "economics": {
    "rfc_items": 123,
    "sweep_items": 123,
    "rfc_subtotal": 123,
    "sweep_subtotal": 123,
    "estimated_rfc_profit": 123,
    "estimated_sweep_profit": 123,
    "total_estimated_profit": 123
  }
}

Path Parameters

id
string<uuid>
required

Response

200 - application/json

Order details

order
object
required
items
object[]
required
fulfillment
object
required
sweeps
object[]
required
economics
object
required