/v1/workspaces/{workspace

post https://data.getangler.ai/v1/workspaces/{workspace_id}/data/orders

Path Params

workspace_id

string

required

Body Params

src

string

dataset_id

string

load_id

string

data

array of objects

required

length between 1 and 500

data*

app_id

string | null

The ID of the app that created the order.

billing_address

object | null

The mailing address associated with the payment method.

browser_ip

string | null

The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported.

buyer_accepts_marketing

boolean | null

Whether the customer consented to receive email updates from the shop.

cancel_reason

string | null

The reason why the order was canceled.

cancelled_at

date-time | null

The date and time when the order was canceled. Returns null if the order isn't canceled.

checkout_id

string | null

The ID of the checkout.

client_details

object | null

Information about the browser that the customer used when they placed their order.

closed_at

date-time | null

The date and time (ISO 8601 format) when the order was closed.

confirmed

boolean | null

contact_email

string | null

created_at

date-time | null

The autogenerated date and time (ISO 8601 format) when the order was created.

currency

string | null

The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order.

current_subtotal_price

string | null

The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

current_total_discounts

string | null

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

current_total_price

string | null

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

current_total_tax

string | null

The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds.

customer_id

string | null

A unique identifier for the customer.

discount_applications

array of objects or null | null

An ordered list of stacked discount applications. The discount_applications property includes 3 types: discount_code, manual, and script. All 3 types share a common structure and have some type specific attributes.

discount_applications

discount_codes

array of objects or null | null

A list of discounts applied to the order.

discount_codes

string | null

The customer's email address.

estimated_taxes

boolean | null

Whether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes.

financial_status

string | null

The status of payments associated with the order.

fulfillment_status

string | null

The order's status in terms of fulfilled line items.

fulfillments

array of objects or null | null

An array of fulfillments associated with the order.

fulfillments

gateway

string | null

The payment gateway used.

string

required

The ID of the order, used for API purposes.

landing_site

string | null

The URL for the page where the buyer landed when they entered the shop.

landing_site_ref

string | null

The ID of one of the locations that was assigned to fulfill the order when the order was created.

location_id

string | null

The ID of one of the locations that was assigned to fulfill the order when the order was created.

name

string | null

The order name.

note

string | null

An optional note that a shop owner can attach to the order.

note_attributes

array of objects or null | null

Extra information that is added to the order.

note_attributes

number

integer | null

The order's position in the shop's count of orders. Numbers are sequential and start at 1.

order_number

integer | null

The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001.

payment_details

object | null

An object containing information about the payment.

phone

string | null

The customer's phone number for receiving SMS notifications.

presentment_currency

string | null

The presentment currency that was used to display prices to the customer.

processed_at

date-time | null

The date and time (ISO 8601 format) when an order was processed.

processing_method

string | null

How the payment was processed.

reference

string | null

referring_site

string | null

The website where the customer clicked a link to the shop.

shipping_address

object | null

The mailing address associated with the payment method.

source_identifier

string | null

The ID of the order placed on the originating platform.

source_name

string | null

The source of the checkout.

source_url

string | null

A valid URL to the original order on the originating surface.

subtotal_price

string | null

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

201Default Response