Skip to main content
GET
/
api
/
v2
/
orders
/
{order_id}
cURL
curl --request GET \
  --url https://take.app/api/v2/orders/{order_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "number": "<string>",
  "payment_method": "<string>",
  "remark": "<string>",
  "internal_note": "<string>",
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "latitude": 123,
      "longitude": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "line_items": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "variant_id": "<string>",
      "name": "<string>",
      "sku": "<string>",
      "quantity": 123,
      "quantity_float": 123,
      "unit": "<string>",
      "unit_value": 123,
      "price": 123,
      "total_amount": 123,
      "options": [
        {
          "question_id": "<string>",
          "question_text": "<string>",
          "question_type": "<string>",
          "answers": [
            "<string>"
          ],
          "prices": [
            123
          ],
          "option_ids": [
            "<string>"
          ],
          "text": "<string>",
          "image_urls": [
            "<string>"
          ]
        }
      ],
      "image_urls": [
        "<string>"
      ]
    }
  ],
  "answers": [
    {
      "id": "<string>",
      "question_id": "<string>",
      "question_text": "<string>",
      "answers": [
        "<string>"
      ],
      "prices": [
        123
      ],
      "option_ids": [
        "<string>"
      ],
      "image_urls": [
        "<string>"
      ]
    }
  ],
  "discounts": [
    {
      "id": "<string>",
      "name": "<string>",
      "amount": 123,
      "type": "<string>"
    }
  ],
  "service": {
    "title": "<string>",
    "name": "<string>",
    "price": 123,
    "distance": 123,
    "distance_unit": "<string>"
  },
  "schedule": {
    "date": "2023-11-07T05:31:56Z",
    "time": "2023-11-07T05:31:56Z",
    "time_end": "2023-11-07T05:31:56Z",
    "timezone": "<string>"
  },
  "items_quantity": 123,
  "items_amount": 123,
  "answers_amount": 123,
  "discounts_amount": 123,
  "service_amount": 123,
  "service_charge_amount": 123,
  "tip_amount": 123,
  "adjustment_amount": 123,
  "total_before_tax": 123,
  "tax_amount": 123,
  "total_amount": 123,
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://platform.take.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Merchant API V2 token. Pass as Authorization: Bearer <token>.

Path Parameters

order_id
string
required

Response

Order

id
string
required
object
enum<string>
required
Available options:
order
number
string
required
order_status
enum<string>
required
Available options:
draft,
pending,
confirmed,
completed,
cancelled
payment_status
enum<string>
required
Available options:
pending,
confirming,
partial,
paid,
refunded,
voided
payment_method
string | null
required
fulfillment_status
enum<string>
required
Available options:
unfulfilled,
ready,
in_transit,
out_for_delivery,
fulfilled,
partially_fulfilled
remark
string | null
required
internal_note
string | null
required
customer
object
required
line_items
object[]
required
answers
object[]
required
discounts
object[]
required
service
object
required
schedule
object
required
items_quantity
integer
required
items_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

answers_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

discounts_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

service_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

service_charge_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

tip_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

adjustment_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

total_before_tax
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

tax_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

total_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

currency
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required