Skip to main content
POST
/
2023-11
/
admin
/
orders
Create
curl --request POST \
  --url https://api-staging.genuka.com/2023-11/admin/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing": {
    "address": {
      "city": "Douala",
      "country": "Cameroon",
      "line1": "Bali DHL"
    },
    "amount": 14000,
    "method": "pawapay",
    "scheduled_at": "18/01/2024"
  },
  "created_at": "2025-09-18T00:00:00.000Z",
  "currency": "XAF",
  "customer": {
    "city": "Douala",
    "last_name": "Gaëlle",
    "line1": "Bali (DHL$",
    "phone": "697120598"
  },
  "products": [
    {
      "cost": 3800,
      "price": 15000,
      "quantity": 1,
      "title": "Sac bleu"
    }
  ],
  "shipping": {
    "address": {
      "city": "Douala",
      "country": "Cameroon",
      "line1": "Bali DHL"
    },
    "address_id": null,
    "mode": "delivery",
    "scheduled_at": "2024-01-18"
  },
  "source": "EXCEL"
}
'
{
  "amount": 15000,
  "amount_due": 15000,
  "billing": {
    "address": {
      "addressable_id": "01k76xt7z87katy392s6w335cp",
      "addressable_type": "App\\Models\\Order",
      "city": "Douala",
      "company": null,
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "country": "Cameroon",
      "created_at": "2025-10-10T11:24:04.000000Z",
      "email": null,
      "first_name": "",
      "id": "01k76xt7zemw3x8jep88ee1rq9",
      "is_billing": 1,
      "is_primary": 1,
      "is_shipping": 0,
      "label": null,
      "last_name": "Gaëlle",
      "latitude": null,
      "line1": "Bali DHL",
      "line2": null,
      "longitude": null,
      "metadata": null,
      "phone": null,
      "postal_code": null,
      "state": null,
      "updated_at": "2025-10-10T11:24:04.000000Z"
    },
    "address_id": "01k76xt7zemw3x8jep88ee1rq9",
    "amount": 14000,
    "discount": 0,
    "line_discounts_total": 0,
    "method": "pawapay",
    "net_to_pay": 15000,
    "order_discounts_total": 0,
    "out_of_tax_total": 15000,
    "scheduled_at": "18/01/2024",
    "shipping": 0,
    "status": "pending",
    "subtotal": 15000,
    "sum_negative_taxes": 0,
    "sum_positive_taxes": 0,
    "total": 15000,
    "treasury_account": {
      "accounting_account_code": "538",
      "balance": 37934,
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "created_at": "2025-07-30T09:58:30.000000Z",
      "id": "01k1d8vxr0xdthhtb6zy1e97dt",
      "label": "PawaPay",
      "logoUrl": null,
      "medias": [],
      "metadata": {
        "connected_api": true,
        "currency_code": "XAF",
        "currency_name": "FCFA",
        "notification": true
      },
      "shop": null,
      "shop_id": null,
      "type": "pawapay",
      "updated_at": "2025-10-03T10:35:13.000000Z"
    },
    "treasury_account_id": "01k1d8vxr0xdthhtb6zy1e97dt",
    "treasury_account_label": "PawaPay"
  },
  "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-09-18T00:00:00.000000Z",
  "credit_code": "701",
  "currency": "XAF",
  "custom_fields": [],
  "customer_id": "01k76xt7v9aq02r798c0c9nqhf",
  "debit_code": "4111",
  "deleted_at": null,
  "deliveries": [],
  "delivery": null,
  "due_at": null,
  "expires_at": null,
  "id": "01k76xt7z87katy392s6w335cp",
  "invoices_count": 0,
  "medias": [],
  "metadata": {
    "matchingMediaIds": []
  },
  "order_products": [
    {
      "created_at": "2025-10-10T11:24:04.000000Z",
      "id": 4839,
      "metadata": {
        "assigned_at": "2025-10-10T11:24:05.003172Z",
        "assigned_by": "observer_auto_assignment",
        "auto_assigned_sales_user": true,
        "cost_at_date": null,
        "item_title": "Sac bleu",
        "product_media": "",
        "product_title": "Sac bleu",
        "sales_user_id": "01k1amyqgjje8sknkzpm78qv6x",
        "stock_warehouse_to_remove": [],
        "taxes": [],
        "variant_image": null,
        "variant_sku": null,
        "variant_title": "Default Title"
      },
      "order_id": "01k76xt7z87katy392s6w335cp",
      "price": 15000,
      "product_id": "01k76xt7vxsnae0vz36ddgt4bz",
      "quantity": 1,
      "service_id": null,
      "updated_at": "2025-10-10T11:24:04.000000Z",
      "variant_id": "01k76xt7x2zgs1gfnt0fwcmrsy"
    }
  ],
  "pickup_location": null,
  "pickup_location_id": null,
  "private_medias": [],
  "products": [
    {
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "content": null,
      "created_at": "2025-10-10T11:24:04.000000Z",
      "deleted_at": null,
      "discounts": [],
      "handle": "sac-bleu-l4KP4",
      "id": "01k76xt7vxsnae0vz36ddgt4bz",
      "is_shippable": 1,
      "is_taxable": 1,
      "medias": [],
      "metadata": null,
      "pivot": {
        "id": 4839,
        "metadata": {
          "assigned_at": "2025-10-10T11:24:05.003172Z",
          "assigned_by": "observer_auto_assignment",
          "auto_assigned_sales_user": true,
          "cost_at_date": null,
          "item_title": "Sac bleu",
          "product_media": "",
          "product_title": "Sac bleu",
          "sales_user_id": "01k1amyqgjje8sknkzpm78qv6x",
          "stock_warehouse_to_remove": [],
          "taxes": [],
          "variant_image": null,
          "variant_sku": null,
          "variant_title": "Default Title"
        },
        "order_id": "01k76xt7z87katy392s6w335cp",
        "price": 15000,
        "product_id": "01k76xt7vxsnae0vz36ddgt4bz",
        "quantity": 1,
        "service_id": null,
        "variant": {
          "barcode": null,
          "base_title": "Default Title",
          "compare_at_price": null,
          "composite_stocks": [],
          "created_at": "2025-10-10T11:24:04.000000Z",
          "deleted_at": null,
          "estimated_quantity": null,
          "estimated_quantity_by_warehouse": [],
          "follow_stock": 0,
          "id": "01k76xt7x2zgs1gfnt0fwcmrsy",
          "image_id": null,
          "metadata": null,
          "min_order_quantity": 1,
          "options": [
            0
          ],
          "position": 0,
          "price": 15000,
          "product_id": "01k76xt7vxsnae0vz36ddgt4bz",
          "sku": null,
          "supplierproduct": null,
          "taxable": 1,
          "title": "Default Title",
          "updated_at": "2025-10-10T11:24:04.000000Z",
          "whatsapp_product_id": null
        },
        "variant_id": "01k76xt7x2zgs1gfnt0fwcmrsy"
      },
      "professionals": [],
      "published": 0,
      "service": null,
      "supplier_id": null,
      "tags": [],
      "taxes": [],
      "title": "Sac bleu",
      "type": "physical_goods",
      "updated_at": "2025-10-10T11:24:04.000000Z",
      "vendor": null
    }
  ],
  "reference": "#ORDER_1174",
  "returns_count": 0,
  "revenue_type": "PRODUCTS",
  "shipping": {
    "address": {
      "addressable_id": "01k76xt7z87katy392s6w335cp",
      "addressable_type": "App\\Models\\Order",
      "city": "Douala",
      "company": null,
      "company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
      "country": "Cameroon",
      "created_at": "2025-10-10T11:24:04.000000Z",
      "email": null,
      "first_name": null,
      "id": "01k76xt7zgpvv1pfe177sqcsr4",
      "is_billing": 0,
      "is_primary": 1,
      "is_shipping": 1,
      "label": null,
      "last_name": null,
      "latitude": null,
      "line1": "Bali DHL",
      "line2": null,
      "longitude": null,
      "metadata": null,
      "phone": null,
      "postal_code": null,
      "state": null,
      "updated_at": "2025-10-10T11:24:04.000000Z"
    },
    "address_id": "01k76xt7zgpvv1pfe177sqcsr4",
    "amount": 0,
    "mode": "delivery",
    "scheduled_at": "2024-01-18",
    "status": "pending"
  },
  "shipping_fee": null,
  "shipping_fee_id": null,
  "shop_id": "01k1amypzhgs7fngfx1r9d37pn",
  "signature": null,
  "source": "EXCEL",
  "state": 1,
  "status": "pending",
  "updated_at": "2025-10-10T11:24:05.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}}"

Body

application/json
billing
object
created_at
string
Example:

"2025-09-18T00:00:00.000Z"

currency
string
Example:

"XAF"

customer
object
products
object[]
Example:
[
{
"cost": 3800,
"price": 15000,
"quantity": 1,
"title": "Sac bleu"
}
]
shipping
object
source
string
Example:

"EXCEL"

Response

200 - application/json

200 OK

amount
number
Example:

15000

amount_due
number
Example:

15000

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

"01hqydxwtxdj3kmzp3bz7jk73g"

created_at
string
Example:

"2025-09-18T00:00:00.000000Z"

credit_code
string
Example:

"701"

currency
string
Example:

"XAF"

custom_fields
any[]
Example:
[]
customer_id
string
Example:

"01k76xt7v9aq02r798c0c9nqhf"

debit_code
string
Example:

"4111"

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

"01k76xt7z87katy392s6w335cp"

invoices_count
number
Example:

0

medias
any[]
Example:
[]
metadata
object
order_products
object[]
Example:
[
{
"created_at": "2025-10-10T11:24:04.000000Z",
"id": 4839,
"metadata": {
"assigned_at": "2025-10-10T11:24:05.003172Z",
"assigned_by": "observer_auto_assignment",
"auto_assigned_sales_user": true,
"cost_at_date": null,
"item_title": "Sac bleu",
"product_media": "",
"product_title": "Sac bleu",
"sales_user_id": "01k1amyqgjje8sknkzpm78qv6x",
"stock_warehouse_to_remove": [],
"taxes": [],
"variant_image": null,
"variant_sku": null,
"variant_title": "Default Title"
},
"order_id": "01k76xt7z87katy392s6w335cp",
"price": 15000,
"product_id": "01k76xt7vxsnae0vz36ddgt4bz",
"quantity": 1,
"service_id": null,
"updated_at": "2025-10-10T11:24:04.000000Z",
"variant_id": "01k76xt7x2zgs1gfnt0fwcmrsy"
}
]
pickup_location
unknown
pickup_location_id
unknown
private_medias
any[]
Example:
[]
products
object[]
Example:
[
{
"company_id": "01hqydxwtxdj3kmzp3bz7jk73g",
"content": null,
"created_at": "2025-10-10T11:24:04.000000Z",
"deleted_at": null,
"discounts": [],
"handle": "sac-bleu-l4KP4",
"id": "01k76xt7vxsnae0vz36ddgt4bz",
"is_shippable": 1,
"is_taxable": 1,
"medias": [],
"metadata": null,
"pivot": {
"id": 4839,
"metadata": {
"assigned_at": "2025-10-10T11:24:05.003172Z",
"assigned_by": "observer_auto_assignment",
"auto_assigned_sales_user": true,
"cost_at_date": null,
"item_title": "Sac bleu",
"product_media": "",
"product_title": "Sac bleu",
"sales_user_id": "01k1amyqgjje8sknkzpm78qv6x",
"stock_warehouse_to_remove": [],
"taxes": [],
"variant_image": null,
"variant_sku": null,
"variant_title": "Default Title"
},
"order_id": "01k76xt7z87katy392s6w335cp",
"price": 15000,
"product_id": "01k76xt7vxsnae0vz36ddgt4bz",
"quantity": 1,
"service_id": null,
"variant": {
"barcode": null,
"base_title": "Default Title",
"compare_at_price": null,
"composite_stocks": [],
"created_at": "2025-10-10T11:24:04.000000Z",
"deleted_at": null,
"estimated_quantity": null,
"estimated_quantity_by_warehouse": [],
"follow_stock": 0,
"id": "01k76xt7x2zgs1gfnt0fwcmrsy",
"image_id": null,
"metadata": null,
"min_order_quantity": 1,
"options": [0],
"position": 0,
"price": 15000,
"product_id": "01k76xt7vxsnae0vz36ddgt4bz",
"sku": null,
"supplierproduct": null,
"taxable": 1,
"title": "Default Title",
"updated_at": "2025-10-10T11:24:04.000000Z",
"whatsapp_product_id": null
},
"variant_id": "01k76xt7x2zgs1gfnt0fwcmrsy"
},
"professionals": [],
"published": 0,
"service": null,
"supplier_id": null,
"tags": [],
"taxes": [],
"title": "Sac bleu",
"type": "physical_goods",
"updated_at": "2025-10-10T11:24:04.000000Z",
"vendor": null
}
]
reference
string
Example:

"#ORDER_1174"

returns_count
number
Example:

0

revenue_type
string
Example:

"PRODUCTS"

shipping
object
shipping_fee
unknown
shipping_fee_id
unknown
shop_id
string
Example:

"01k1amypzhgs7fngfx1r9d37pn"

signature
unknown
source
string
Example:

"EXCEL"

state
number
Example:

1

status
string
Example:

"pending"

updated_at
string
Example:

"2025-10-10T11:24:05.000000Z"

user_id
string
Example:

"01k1amyqgjje8sknkzpm78qv6x"