Create order

post

https://api.gobeeping.com/api/v1/client/orders

What is it for?

Creates a new order in the system.

Conditions

Requires authentication.
Each array element is a product in the order. Minimum 1 line required. In each line you must identify the product with ONE of these three fields: product_id, pack_id or name. You do not need to send all three.

Parameters

Fill in the fields in Body Params, Query Params and/or Path Params as applicable.

External Financial Status Reference

The external_financial_status field reflects the financial state coming from the external e-commerce platform (Shopify, WooCommerce, MercadoPago). Accepted values:

Value	Meaning
paid	Order has been paid
pending	Order pending payment
refunded	Order has been refunded
partially_refunded	Order has been partially refunded

Note: When sent in a request (POST/PUT), the value is accepted as free string and stored as-is.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

external_id

string

required

External order identifier. Copy it from your system (Shopify, WooCommerce, etc.)

ref

string

required

Internal order reference

payment_method_id

integer | null

Payment method ID (can be null)

external_payment_method

string | null

External payment method name

external_financial_status

string | null

External financial status (e.g.: 'paid', 'pending')

order_created_at

date-time

required

Date and time the order was created (valid date/time format)

order_paid_at

date-time | null

Date and time the order was paid (if applicable)

customer

object

required

Customer information

total_tax

float

required

Total order taxes

total_shipping

float

required

Total shipping cost

total_discount

float

required

Total discount applied to the order

currency

string

required

Currency code (e.g.: 'EUR', 'USD')

shop_id

integer

required

ID of the shop the order belongs to

lines

array of objects

required

length ≥ 1

Order line items (at least 1)

lines*

product_id

integer | null

Associated product ID (required if name or pack_id is not provided)

name

string | null

Product name (required if product_id or pack_id is not provided)

quantity

integer

required

Number of items in the line

amount

float

required

Total cost for this line (subtotal)

external_product_id

string | null

External product ID

external_variant_id

string | null

External product variant ID

pack_id

integer | null

Pack ID (required if name or product_id is not provided)

Responses

400

Malformed request or invalid data

401

Unauthorized (invalid or expired token)

422

Validation error

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Order created successfully