API Reference

post_v1-workspaces-workspace-id-data-orders

post
https://data.getangler.ai/v1/workspaces//data/orders
Path Params
string
required
Body Params
string
enum
Allowed:
string
string
data
array of objects
required
length between 1 and 500
data*
string | null

The ID of the app that created the order.

billing_address
object | null

The mailing address associated with the payment method.

string | null

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

boolean | null

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

string | null

The reason why the order was canceled.

date-time | null

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

string | null

The ID of the checkout.

client_details
object | null

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

string | null

The browser or device ID used when this order was placed.

date-time | null

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

boolean | null
string | null
date-time
required

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

string | null

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

string | null

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

string | null

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

string | null

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

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.

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.

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.

string | null

The status of payments associated with the order.

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
string | null

The payment gateway used.

string | null

Hashed customer's email in SHA256 (lower case).

string | null

Hashed customer's phone in SHA256 (lower case).

string
required
length ≥ 1

The ID of the order, used for API purposes.

string | null

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

string | null

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

line_items
array of objects | null

List of line items in the order.

line_items
string
required
length ≥ 1

The ID of the line item.

number | null

The number of items from the line item that have been fulfilled.

string | null

The fulfillment service for the vartiant associated with the line item.

string | null

The fulfillment status of the checkout.

boolean | null

Represents an issued gift card.

string | null

The name of the product associated.

string | null

The price of the product associated.

boolean | null

Whether the product exists.

string | null

The ID of the line item's product.

properties
array of objects or null | null

The properties of the line item.

properties
number | null

The quantity of the line item.

boolean | null

Whether the product requires shipping.

string | null

The sku of the variant associated with the line item.

boolean | null

Whether the product is taxable.

string | null

The title of the line item.

string | null

The total amount, in the currency's subunit, of any discounts applied to the line item.

string | null

The ID of the line item's variant.

string | null

The inventory management service of the variant.

string | null

A concatenation of each variant option, separated by a /

string | null

The vendor of the variant associated with the line item.

additional_fields
array of objects | null

Extra properties.

additional_fields
string | null

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

string | null

The order name.

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
integer | null

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

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.

string | null

The customer's phone number for receiving SMS notifications.

string | null

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

date-time | null

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

string | null

How the payment was processed.

string | null
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.

string | null

The ID of the order placed on the originating platform.

string | null

The source of the checkout.

string | null

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

string | null

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

string | null

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

boolean | null

Whether taxes are included in the order subtotal.

string | null

The total discounts applied to the price of the order in the shop currency.

string | null

The sum of all line item prices in the shop currency.

string | null

The total outstanding amount of the order in the shop currency.

string | null

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

string | null

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency in USD

string | null

The sum of all the taxes applied to the order in the shop currency. Must be positive.

string | null

The sum of all the tips in the order in the shop currency.

string | null

The ID of the user logged into Shopify POS who processed the order, if applicable.

date-time | null

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

additional_fields
array of objects | null

Extra properties.

additional_fields
Response

Updated 15 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago