Skip to main content
GET
/
2023-11
/
admin
/
orders
/
{id}
{
  "addresses": [],
  "amount": 6600,
  "amount_due": 5600,
  "billing": {
    "address": null,
    "address_id": null,
    "discount": 0,
    "method": "01k1amypp3pjw47pqemjv7jx31",
    "net_to_pay": 6600,
    "out_of_tax_total": 6600,
    "shipping": 0,
    "status": "partially_paid",
    "subtotal": 6600,
    "sum_negative_taxes": 0,
    "sum_positive_taxes": 0,
    "total": 6600,
    "treasury_account": {
      "accounting_account_code": "52",
      "balance": -551433,
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "created_at": "2025-07-29T09:32:00.000000Z",
      "id": "01k1amypp3pjw47pqemjv7jx31",
      "label": "Bank",
      "logoUrl": null,
      "medias": [],
      "metadata": {
        "connected_api": false,
        "currency_code": "XAF",
        "currency_name": "FCFA",
        "notification": false
      },
      "shop": null,
      "shop_id": null,
      "type": "bank",
      "updated_at": "2025-10-03T09:57:44.000000Z"
    },
    "treasury_account_id": "01k1amypp3pjw47pqemjv7jx31",
    "treasury_account_label": "Bank"
  },
  "bills": [],
  "calendar_event_id": null,
  "company": {
    "address": null,
    "company_code": null,
    "created_at": "2025-07-29T09:31:59.000000Z",
    "currency_code": "XAF",
    "currency_name": "FCFA",
    "description": null,
    "handle": "demo-company",
    "id": "01hqydxwtxdj3kmzp3bz7jk73g",
    "logoUrl": null,
    "medias": [],
    "metadata": {
      "payment_terms": {
        "accepted_at": "2025-07-30T08:57:08.517Z",
        "accepted_by": "Payton Donnelly "
      }
    },
    "name": "Demo Company",
    "onboarding": {
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "created_at": "2025-07-29T09:36:28.000000Z",
      "finished_at": "2025-07-29T09:36:28.000000Z",
      "id": 1,
      "metadata": [],
      "started_at": "2025-07-29T09:36:28.000000Z",
      "step": "source",
      "updated_at": "2025-07-29T09:36:28.000000Z"
    },
    "paymentMethods": [
      {
        "account_id": null,
        "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
        "configurations": [],
        "id": "01k1d8sk6mz3r0fyqwmqr1y9k7",
        "metadata": null,
        "name": "Cash",
        "processor": "cash",
        "status": 1,
        "treasury_account_id": "01k1amypn6xycwe7w948jp82zm"
      },
      {
        "account_id": null,
        "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
        "configurations": {
          "api_token": "********************************"
        },
        "id": "01k1d8vxr5dbcjpm0gh2yqaf59",
        "metadata": null,
        "name": "PawaPay",
        "processor": "pawapay",
        "status": 1,
        "treasury_account_id": "01k1d8vxr0xdthhtb6zy1e97dt"
      },
      {
        "account_id": null,
        "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
        "configurations": [],
        "id": "01k76v7gky6xvvxkg7t5s0frka",
        "metadata": null,
        "name": "NotchPay",
        "processor": "notchpay",
        "status": 1,
        "treasury_account_id": "01k76v7gk9j9tfsbr4g8zwc725"
      }
    ],
    "type": "business",
    "updated_at": "2025-07-30T09:57:08.000000Z",
    "variables": null
  },
  "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
  "created_at": "2025-07-30T09:05:53.000000Z",
  "credit_code": "701",
  "currency": "XAF",
  "custom_fields": [],
  "customer": null,
  "customer_id": null,
  "customer_orders_count": 0,
  "debit_code": "4111",
  "deleted_at": null,
  "deliveries": [],
  "delivery": null,
  "discounts": [],
  "due_at": null,
  "expires_at": null,
  "id": "01k1d99mheywy0tsdnftma8907",
  "invoices": [
    {
      "amount": 1000,
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "created_at": "2025-07-30T10:06:00.000000Z",
      "currency_code": "XAF",
      "deleted_at": null,
      "id": "01k1d99nwnewgq5rxfy05tcs13",
      "is_deposit": true,
      "is_final": false,
      "medias": [],
      "metadata": null,
      "order_id": "01k1d99mheywy0tsdnftma8907",
      "reference": "#INV_1001",
      "shop_id": "01k1amypzhgs7fngfx1r9d37pn",
      "status": "paid",
      "updated_at": "2025-07-30T10:06:00.000000Z",
      "user_id": "01k1amyqgjje8sknkzpm78qv6x"
    }
  ],
  "invoices_count": 1,
  "medias": [],
  "metadata": {
    "matchingMediaIds": [],
    "note": null,
    "print_receipt": false
  },
  "order_products": [
    {
      "created_at": null,
      "id": 2899,
      "metadata": {
        "cost_at_date": null,
        "item_title": "Black whisk",
        "product_media": "",
        "product_title": "Black Whisk",
        "stock_warehouse_to_remove": [
          {
            "batch_number": "batch_01k1amzt3zvbd3k46v3xq2vnjg",
            "expiration_date": "2026-01-29 09:32:37",
            "production_date": "2025-06-29 09:32:37",
            "quantity": 1,
            "stock_warehouse_id": "149"
          }
        ],
        "taxes": [],
        "variant_image": null,
        "variant_sku": null,
        "variant_title": "Default Title"
      },
      "order_id": "01k1d99mheywy0tsdnftma8907",
      "price": 6600,
      "product_id": "01k1amzt10qsysja4esbkw85s8",
      "quantity": 1,
      "service_id": null,
      "updated_at": null,
      "variant_id": "01k1amzt38a9pz5zv0zh6cj0qp"
    }
  ],
  "pickup_location": null,
  "pickup_location_id": null,
  "private_medias": [],
  "products": [
    {
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "content": "The Black Whisk is a kitchen essential for whisking and beating ingredients. Its ergonomic handle and sleek design make it a practical and stylish tool.",
      "created_at": "2025-07-29T09:32:36.000000Z",
      "deleted_at": null,
      "discounts": [],
      "handle": "black-whisk",
      "id": "01k1amzt10qsysja4esbkw85s8",
      "is_shippable": 1,
      "is_taxable": 1,
      "medias": [],
      "metadata": null,
      "pivot": {
        "id": 2899,
        "metadata": {
          "cost_at_date": null,
          "item_title": "Black whisk",
          "product_media": "",
          "product_title": "Black Whisk",
          "stock_warehouse_to_remove": [
            {
              "batch_number": "batch_01k1amzt3zvbd3k46v3xq2vnjg",
              "expiration_date": "2026-01-29 09:32:37",
              "production_date": "2025-06-29 09:32:37",
              "quantity": 1,
              "stock_warehouse_id": "149"
            }
          ],
          "taxes": [],
          "variant_image": null,
          "variant_sku": null,
          "variant_title": "Default Title"
        },
        "order_id": "01k1d99mheywy0tsdnftma8907",
        "price": 6600,
        "product_id": "01k1amzt10qsysja4esbkw85s8",
        "quantity": 1,
        "service_id": null,
        "variant": {
          "barcode": "2190002687366",
          "base_title": "Default Title",
          "compare_at_price": null,
          "composite_stocks": [],
          "created_at": "2025-07-29T09:32:36.000000Z",
          "deleted_at": null,
          "estimated_quantity": 80,
          "estimated_quantity_by_warehouse": {
            "01k1amypz43jvgqzkkanv5sj2k": 27,
            "01k1amyq0feb1zj6qaw9v5zc5s": 0,
            "01k1amyq271bm81tncbepdxa2j": 53
          },
          "follow_stock": 1,
          "id": "01k1amzt38a9pz5zv0zh6cj0qp",
          "image_id": null,
          "metadata": null,
          "min_order_quantity": 1,
          "options": [
            0
          ],
          "position": 0,
          "price": 6600,
          "product_id": "01k1amzt10qsysja4esbkw85s8",
          "sku": null,
          "supplierproduct": null,
          "taxable": 1,
          "title": "Default Title",
          "updated_at": "2025-08-11T11:05:55.000000Z",
          "whatsapp_product_id": null
        },
        "variant_id": "01k1amzt38a9pz5zv0zh6cj0qp"
      },
      "professionals": [],
      "published": 1,
      "service": null,
      "supplier_id": null,
      "tags": [],
      "taxes": [],
      "title": "Black Whisk",
      "type": "physical_goods",
      "updated_at": "2025-07-29T09:32:36.000000Z",
      "vendor": null
    }
  ],
  "reference": "#ORDER_1382",
  "returns": [],
  "returns_count": 0,
  "revenue_type": "products",
  "shipping": {
    "address": null,
    "address_id": null,
    "amount": 0,
    "mode": "pickup",
    "scheduled_at": "2025-07-30T09:05:59.350460Z",
    "status": "pending"
  },
  "shipping_fee": null,
  "shipping_fee_id": null,
  "shop": {
    "address": null,
    "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
    "created_at": "2025-07-29T09:32:01.000000Z",
    "currency_code": "XAF",
    "currency_name": "FCFA",
    "deleted_at": null,
    "description": "Debitis non rerum aperiam tenetur placeat ut dignissimos.",
    "domains": [],
    "id": "01k1amypzhgs7fngfx1r9d37pn",
    "logo": null,
    "logoUrl": "",
    "metadata": null,
    "name": "Brekke Group",
    "slug": "brekke-group",
    "updated_at": "2025-07-29T09:32:01.000000Z",
    "warehouses": [
      {
        "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
        "created_at": "2025-07-29T09:32:01.000000Z",
        "deleted_at": null,
        "description": "Quasi magnam repudiandae non illum veniam autem ad alias.",
        "id": "01k1amyq0feb1zj6qaw9v5zc5s",
        "metadata": null,
        "name": "Bogan Inc Warehouse",
        "pivot": {
          "metadata": null,
          "shop_id": "01k1amypzhgs7fngfx1r9d37pn",
          "warehouse_id": "01k1amyq0feb1zj6qaw9v5zc5s"
        },
        "updated_at": "2025-07-29T09:32:01.000000Z"
      }
    ]
  },
  "shop_id": "01k1amypzhgs7fngfx1r9d37pn",
  "signature": null,
  "source": "POS",
  "state": 1,
  "status": "pending",
  "subscriptions": [],
  "taxes": [],
  "updated_at": "2025-07-30T10:06:00.000000Z",
  "user": {
    "allPermissions": [
      "payments.*",
      "payments.view",
      "payments.create",
      "payments.update",
      "payments.delete",
      "invoices.*",
      "invoices.view",
      "invoices.create",
      "invoices.update",
      "invoices.delete",
      "returns.*",
      "returns.view",
      "returns.create",
      "returns.update",
      "returns.delete",
      "returns.approve",
      "*",
      "orders.*",
      "orders.view",
      "orders.create",
      "orders.update",
      "orders.delete",
      "orders.export",
      "products.*",
      "products.view",
      "products.create",
      "products.update",
      "products.delete",
      "products.export",
      "products.cost",
      "customers.*",
      "customers.view",
      "customers.create",
      "customers.update",
      "customers.delete",
      "customers.addresses",
      "customers.stats",
      "customers.export",
      "collections.*",
      "collections.view",
      "collections.create",
      "collections.update",
      "collections.delete",
      "deliveries.*",
      "deliveries.view",
      "deliveries.create",
      "deliveries.update",
      "deliveries.delete",
      "stats.*",
      "stats.view",
      "discounts.*",
      "discounts.view",
      "discounts.create",
      "discounts.update",
      "discounts.delete",
      "company.*",
      "shops.*",
      "warehouses.*",
      "users.*",
      "stocks.*",
      "stocks.view",
      "stocks.create",
      "stocks.update",
      "stocks.delete",
      "shipping_fees.*",
      "payment_methods.*",
      "accounting.*",
      "accounting.view",
      "accounting.export",
      "suppliers.*",
      "suppliers.view",
      "suppliers.create",
      "suppliers.update",
      "suppliers.delete",
      "suppliers.export",
      "suppliers.stats",
      "expenses.*",
      "expenses.view",
      "expenses.create",
      "expenses.update",
      "expenses.delete",
      "expenses.export",
      "treasury_accounts.*",
      "taxes.*",
      "transactions.*",
      "website.*",
      "blogs.create",
      "blogs.update",
      "blogs.delete",
      "blogs.*",
      "blogs.view",
      "pages.create",
      "pages.update",
      "pages.delete",
      "pages.*",
      "pages.view",
      "media_files.*",
      "domains.*",
      "company.view",
      "shops.view",
      "warehouses.view",
      "users.view",
      "webhooks.*",
      "webhooks.view",
      "webhooks.create",
      "webhooks.update",
      "webhooks.delete",
      "webhooks.test",
      "marketing.*",
      "marketing.campaigns.view",
      "marketing.campaigns.create",
      "marketing.campaigns.update",
      "marketing.campaigns.delete",
      "marketing.templates.*",
      "marketing.templates.view",
      "marketing.templates.create",
      "marketing.templates.update",
      "marketing.templates.delete",
      "orders.change_user"
    ],
    "birthdate": null,
    "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
    "created_at": "2025-07-29T09:32:01.000000Z",
    "deleted_at": null,
    "email": "[email protected]",
    "first_name": "Payton",
    "id": "01k1amyqgjje8sknkzpm78qv6x",
    "last_activity": "2025-10-10 11:22:28",
    "last_login_at": null,
    "last_login_ip": null,
    "last_name": "Donnelly",
    "medias": [],
    "metadata": {
      "lang": "fr"
    },
    "name": "Payton Donnelly",
    "opt_in": 0,
    "permissions": [
      "payments.*",
      "payments.view",
      "payments.create",
      "payments.update",
      "payments.delete",
      "invoices.*",
      "invoices.view",
      "invoices.create",
      "invoices.update",
      "invoices.delete",
      "returns.*",
      "returns.view",
      "returns.create",
      "returns.update",
      "returns.delete",
      "returns.approve",
      "orders.*",
      "orders.view",
      "orders.create",
      "orders.update",
      "orders.delete",
      "orders.export",
      "products.*",
      "products.view",
      "products.create",
      "products.update",
      "products.delete",
      "products.export",
      "products.cost",
      "customers.*",
      "customers.view",
      "customers.create",
      "customers.update",
      "customers.delete",
      "customers.addresses",
      "customers.stats",
      "customers.export",
      "collections.*",
      "collections.view",
      "collections.create",
      "collections.update",
      "collections.delete",
      "deliveries.*",
      "deliveries.view",
      "deliveries.create",
      "deliveries.update",
      "deliveries.delete",
      "stats.*",
      "stats.view",
      "discounts.*",
      "discounts.view",
      "discounts.create",
      "discounts.update",
      "discounts.delete",
      "company.*",
      "shops.*",
      "warehouses.*",
      "users.*",
      "stocks.*",
      "stocks.view",
      "stocks.create",
      "stocks.update",
      "stocks.delete",
      "shipping_fees.*",
      "payment_methods.*",
      "accounting.*",
      "accounting.view",
      "accounting.export",
      "suppliers.*",
      "suppliers.view",
      "suppliers.create",
      "suppliers.update",
      "suppliers.delete",
      "suppliers.export",
      "suppliers.stats",
      "expenses.*",
      "expenses.view",
      "expenses.create",
      "expenses.update",
      "expenses.delete",
      "expenses.export",
      "treasury_accounts.*",
      "taxes.*",
      "transactions.*",
      "website.*",
      "blogs.create",
      "blogs.update",
      "blogs.delete",
      "blogs.*",
      "blogs.view",
      "pages.create",
      "pages.update",
      "pages.delete",
      "pages.*",
      "pages.view",
      "media_files.*",
      "domains.*",
      "company.view",
      "shops.view",
      "warehouses.view",
      "users.view",
      "webhooks.*",
      "webhooks.view",
      "webhooks.create",
      "webhooks.update",
      "webhooks.delete",
      "webhooks.test",
      "marketing.*",
      "marketing.campaigns.view",
      "marketing.campaigns.create",
      "marketing.campaigns.update",
      "marketing.campaigns.delete",
      "marketing.templates.*",
      "marketing.templates.view",
      "marketing.templates.create",
      "marketing.templates.update",
      "marketing.templates.delete",
      "orders.change_user"
    ],
    "phone": "+1 (551) 313-2592",
    "pin_enabled": false,
    "role": "admin",
    "shops": [],
    "updated_at": "2025-10-10T11:22:28.000000Z"
  },
  "user_id": "01k1amyqgjje8sknkzpm78qv6x"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-company
string
Example:

"{{companyId}}"

Path Parameters

id
string
required

Response

200 OK

addresses
any[]
Example:
[]
amount
number
Example:

6600

amount_due
number
Example:

5600

billing
object
bills
any[]
Example:
[]
calendar_event_id
unknown
company
object
company_id
string
Example:

"01hqydxwtxdj3kmzp3bz7jk73g"

created_at
string
Example:

"2025-07-30T09:05:53.000000Z"

credit_code
string
Example:

"701"

currency
string
Example:

"XAF"

custom_fields
any[]
Example:
[]
customer
unknown
customer_id
unknown
customer_orders_count
number
Example:

0

debit_code
string
Example:

"4111"

deleted_at
unknown
deliveries
any[]
Example:
[]
delivery
unknown
discounts
any[]
Example:
[]
due_at
unknown
expires_at
unknown
id
string
Example:

"01k1d99mheywy0tsdnftma8907"

invoices
object[]
Example:
[
{
"amount": 1000,
"company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
"created_at": "2025-07-30T10:06:00.000000Z",
"currency_code": "XAF",
"deleted_at": null,
"id": "01k1d99nwnewgq5rxfy05tcs13",
"is_deposit": true,
"is_final": false,
"medias": [],
"metadata": null,
"order_id": "01k1d99mheywy0tsdnftma8907",
"reference": "#INV_1001",
"shop_id": "01k1amypzhgs7fngfx1r9d37pn",
"status": "paid",
"updated_at": "2025-07-30T10:06:00.000000Z",
"user_id": "01k1amyqgjje8sknkzpm78qv6x"
}
]
invoices_count
number
Example:

1

medias
any[]
Example:
[]
metadata
object
order_products
object[]
Example:
[
{
"created_at": null,
"id": 2899,
"metadata": {
"cost_at_date": null,
"item_title": "Black whisk",
"product_media": "",
"product_title": "Black Whisk",
"stock_warehouse_to_remove": [
{
"batch_number": "batch_01k1amzt3zvbd3k46v3xq2vnjg",
"expiration_date": "2026-01-29 09:32:37",
"production_date": "2025-06-29 09:32:37",
"quantity": 1,
"stock_warehouse_id": "149"
}
],
"taxes": [],
"variant_image": null,
"variant_sku": null,
"variant_title": "Default Title"
},
"order_id": "01k1d99mheywy0tsdnftma8907",
"price": 6600,
"product_id": "01k1amzt10qsysja4esbkw85s8",
"quantity": 1,
"service_id": null,
"updated_at": null,
"variant_id": "01k1amzt38a9pz5zv0zh6cj0qp"
}
]
pickup_location
unknown
pickup_location_id
unknown
private_medias
any[]
Example:
[]
products
object[]
Example:
[
{
"company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
"content": "The Black Whisk is a kitchen essential for whisking and beating ingredients. Its ergonomic handle and sleek design make it a practical and stylish tool.",
"created_at": "2025-07-29T09:32:36.000000Z",
"deleted_at": null,
"discounts": [],
"handle": "black-whisk",
"id": "01k1amzt10qsysja4esbkw85s8",
"is_shippable": 1,
"is_taxable": 1,
"medias": [],
"metadata": null,
"pivot": {
"id": 2899,
"metadata": {
"cost_at_date": null,
"item_title": "Black whisk",
"product_media": "",
"product_title": "Black Whisk",
"stock_warehouse_to_remove": [
{
"batch_number": "batch_01k1amzt3zvbd3k46v3xq2vnjg",
"expiration_date": "2026-01-29 09:32:37",
"production_date": "2025-06-29 09:32:37",
"quantity": 1,
"stock_warehouse_id": "149"
}
],
"taxes": [],
"variant_image": null,
"variant_sku": null,
"variant_title": "Default Title"
},
"order_id": "01k1d99mheywy0tsdnftma8907",
"price": 6600,
"product_id": "01k1amzt10qsysja4esbkw85s8",
"quantity": 1,
"service_id": null,
"variant": {
"barcode": "2190002687366",
"base_title": "Default Title",
"compare_at_price": null,
"composite_stocks": [],
"created_at": "2025-07-29T09:32:36.000000Z",
"deleted_at": null,
"estimated_quantity": 80,
"estimated_quantity_by_warehouse": {
"01k1amypz43jvgqzkkanv5sj2k": 27,
"01k1amyq0feb1zj6qaw9v5zc5s": 0,
"01k1amyq271bm81tncbepdxa2j": 53
},
"follow_stock": 1,
"id": "01k1amzt38a9pz5zv0zh6cj0qp",
"image_id": null,
"metadata": null,
"min_order_quantity": 1,
"options": [0],
"position": 0,
"price": 6600,
"product_id": "01k1amzt10qsysja4esbkw85s8",
"sku": null,
"supplierproduct": null,
"taxable": 1,
"title": "Default Title",
"updated_at": "2025-08-11T11:05:55.000000Z",
"whatsapp_product_id": null
},
"variant_id": "01k1amzt38a9pz5zv0zh6cj0qp"
},
"professionals": [],
"published": 1,
"service": null,
"supplier_id": null,
"tags": [],
"taxes": [],
"title": "Black Whisk",
"type": "physical_goods",
"updated_at": "2025-07-29T09:32:36.000000Z",
"vendor": null
}
]
reference
string
Example:

"#ORDER_1382"

returns
any[]
Example:
[]
returns_count
number
Example:

0

revenue_type
string
Example:

"products"

shipping
object
shipping_fee
unknown
shipping_fee_id
unknown
shop
object
shop_id
string
Example:

"01k1amypzhgs7fngfx1r9d37pn"

signature
unknown
source
string
Example:

"POS"

state
number
Example:

1

status
string
Example:

"pending"

subscriptions
any[]
Example:
[]
taxes
any[]
Example:
[]
updated_at
string
Example:

"2025-07-30T10:06:00.000000Z"

user
object
user_id
string
Example:

"01k1amyqgjje8sknkzpm78qv6x"