/v1/workspaces/{workspace_id}/data/checkouts

post

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

Path Params

workspace_id

string

required

Body Params

src

string

enum

Allowed:

dataset_id

string

load_id

string

data

array of objects

required

length between 1 and 500

data*

string

required

length ≥ 1

string | null

created_at

date-time

required

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

updated_at

date-time | null

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

landing_site

string | null

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

note_attributes

array of objects or null

Extra information that is added to the order. Appears in the Additional details section of an order details page.

note_attributes

referring_site

string | null

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

total_weight

number | null

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

currency

string | null

The three-letter code (ISO 4217 format) for the shop currency.

completed_at

string | null

The date and time (ISO 8601 format) when the checkout was completed.

closed_at

string | null

user_id

string | null

The ID of the user who created the checkout.

location_id

string | null

source_identifier

string | null

The ID of the order placed on the originating platform.

source_url

string | null

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

device_id

number | null

phone

string | null

The customer's phone number for receiving SMS notifications.

customer_locale

string | null

The two or three-letter language code, optionally followed by a region modifier.

name

string | null

Checkout's name.

source

string | null

Where the checkout originated.

discount_codes

array of objects or null | null

A list of discounts applied to the order.

discount_codes

source_name

string | null

The source of the checkout.

presentment_currency

string | null

The three-letter code (ISO 4217 format) for the currency that the customer used for payment at checkout.

buyer_accepts_sms_marketing

boolean | null

Whether the customer would like to receive SMS updates from the shop.

sms_marketing_phone

string | null

The phone number used to opt in to SMS marketing during checkout.

total_discounts

string | null

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

total_line_items_price

string | null

The sum of the prices of all line items in the checkout in presentment currency.

total_price

string | null

The sum of the the checkout line prices, taxes, shipping costs, tips, and discounts in presentment currency.

total_tax

string | null

The sum of all the taxes applied to the checkout in presentment currency.

subtotal_price

string | null

The price of the checkout in presentment currency before shipping, taxes, and tips.

total_duties

string | null

The total duties of the checkout in presentment currency.

billing_address

object | null

The mailing address associated with the payment method.

shipping_address

object | null

The mailing address associated with the payment method.

customer_id

string | null

The ID of the customer associated with this checkout.

additional_fields

array of objects | null

Extra properties.

additional_fields

201Default Response