Bookings
getBusinessProfile
bookings.getBusinessProfile
Retrieves a seller’s booking profile.
Risk: read
await corsair.square.api.bookings.getBusinessProfile({});
| Name | Type | Required | Description |
|---|---|---|---|
business_booking_profile | object | null | No | — |
errors | object[] | null | No | — |
business_booking_profile full type
business_booking_profile full type
{
seller_id?: string | null,
created_at?: string | null,
booking_enabled?: boolean | null,
customer_timezone_choice?: string | null,
booking_policy?: string | null,
allow_user_cancel?: boolean | null,
business_appointment_settings?: {
location_types?: string[] | null,
alignment_time?: string | null,
min_booking_lead_time_seconds?: number | null,
max_booking_lead_time_seconds?: number | null,
any_team_member_booking_enabled?: boolean | null,
multiple_service_booking_enabled?: boolean | null,
max_appointments_per_day_limit_type?: string | null,
max_appointments_per_day_limit?: number | null,
cancellation_window_seconds?: number | null,
cancellation_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
cancellation_policy?: string | null,
cancellation_policy_text?: string | null,
skip_booking_flow_staff_selection?: boolean | null
} | null,
support_seller_level_writes?: boolean | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Cards
create
cards.create
Adds a card on file to an existing merchant. Requires idempotency_key; pass the same key to retry safely.
Risk: write
await corsair.square.api.cards.create({
idempotency_key: '<idempotency key>',
source_id: '<source id>',
card: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A unique string that identifies this CreateCard request. Keys can be any valid string and must be unique for every request. |
source_id | string | Yes | The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. |
verification_token | string | No | An identifying token generated by Payments.verifyBuyer(). |
card | object | Yes | Payment details associated with the card to be stored. |
card full type
card full type
{
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
card | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
card full type
card full type
{
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null
disable
cards.disable
Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.cards.disable({ card_id: '<card id>' });
| Name | Type | Required | Description |
|---|---|---|---|
card_id | string | Yes | Unique ID for the desired Card. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
card | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
card full type
card full type
{
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null
get
cards.get
Retrieves details for a specific Card.
Risk: read
await corsair.square.api.cards.get({ card_id: '<card id>' });
| Name | Type | Required | Description |
|---|---|---|---|
card_id | string | Yes | Unique ID for the desired Card. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
card | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
card full type
card full type
{
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null
list
cards.list
Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.
Risk: read
await corsair.square.api.cards.list({ cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. |
customer_id | string | No | Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned. |
include_disabled | boolean | No | Includes disabled cards. By default, all enabled cards owned by the merchant are returned. |
reference_id | string | No | Limit results to cards associated with the reference_id supplied. |
sort_order | DESC | ASC | No | Sorts the returned list by when the card was created with the specified order. This field defaults to ASC. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
cards | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
cards full type
cards full type
{
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
}[] | null
Catalog
delete
catalog.delete
Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.catalog.delete({ object_id: '<object id>' });
| Name | Type | Required | Description |
|---|---|---|---|
object_id | string | Yes | The ID of the catalog object to be deleted. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
deleted_object_ids | string[] | null | No | — |
deleted_at | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
catalog.get
Returns a single CatalogItem as a CatalogObject based on the provided ID.
Risk: read
await corsair.square.api.catalog.get({ object_id: '<object id>' });
| Name | Type | Required | Description |
|---|---|---|---|
object_id | string | Yes | The object ID of any type of catalog objects to be retrieved. |
include_related_objects | boolean | No | If true, the response will include additional objects that are related to the requested objects. |
catalog_version | number | No | Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. |
include_category_path_to_root | boolean | No | Specifies whether or not to include the path_to_root list for each returned category instance. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
object | object | null | No | — |
related_objects | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
object full type
object full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
} | null
related_objects full type
related_objects full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
list
catalog.list
Returns a list of all CatalogObjects of the specified types in the catalog.
Risk: read
await corsair.square.api.catalog.list({ cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information. |
types | string | No | An optional case-insensitive, comma-separated list of object types to retrieve. |
catalog_version | number | No | The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
cursor | string | null | No | — |
objects | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
objects full type
objects full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
search
catalog.search
Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters.
Risk: read
await corsair.square.api.catalog.search({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information. |
object_types | (ITEM | IMAGE | CATEGORY | ITEM_VARIATION | TAX | DISCOUNT | MODIFIER_LIST | MODIFIER | PRICING_RULE | PRODUCT_SET | TIME_PERIOD | MEASUREMENT_UNIT | SUBSCRIPTION_PLAN_VARIATION | ITEM_OPTION | ITEM_OPTION_VAL | CUSTOM_ATTRIBUTE_DEFINITION | QUICK_AMOUNTS_SETTINGS | SUBSCRIPTION_PLAN | AVAILABILITY_PERIOD)[] | No | The desired set of object types to appear in the search results. |
include_deleted_objects | boolean | No | If true, deleted objects will be included in the results. Defaults to false. Deleted objects will have their is_deleted field set to true. |
include_related_objects | boolean | No | If true, the response will include additional objects that are related to the requested objects. |
begin_time | string | No | Return objects modified after this timestamp, in RFC 3339 format, e.g., 2016-09-04T23:59:33.123Z. |
query | object | No | A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned. |
limit | number | No | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. |
include_category_path_to_root | boolean | No | Specifies whether or not to include the path_to_root list for each returned category instance. |
include_options | object | No | Options to include related resources in the response. |
query full type
query full type
{
sorted_attribute_query?: {
attribute_name: string,
initial_attribute_value?: string | null,
sort_order?: DESC | ASC
},
exact_query?: {
attribute_name: string,
attribute_value: string
},
set_query?: {
attribute_name: string,
attribute_values: string[]
},
prefix_query?: {
attribute_name: string,
attribute_prefix: string
},
range_query?: {
attribute_name: string,
attribute_min_value?: number | null,
attribute_max_value?: number | null
},
text_query?: {
keywords: string[]
},
items_for_tax_query?: {
tax_ids: string[]
},
items_for_modifier_list_query?: {
modifier_list_ids: string[]
},
items_for_item_options_query?: {
item_option_ids?: string[] | null
},
item_variations_for_item_option_values_query?: {
item_option_value_ids?: string[] | null
},
modifiers_for_child_list_query?: {
child_modifier_list_ids: string[]
}
}
include_options full type
include_options full type
{
include?: (INCLUDE_NESTED_MODIFIERS | INCLUDE_ANCESTOR_MODIFIERS)[] | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
cursor | string | null | No | — |
objects | object[] | null | No | — |
related_objects | object[] | null | No | — |
latest_time | string | null | No | — |
included_resources | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
objects full type
objects full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
related_objects full type
related_objects full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
included_resources full type
included_resources full type
{
nested_modifiers?: {
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null,
ancestor_modifiers?: {
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
} | null
upsert
catalog.upsert
Creates a new or updates the specified CatalogObject. Replaces the whole object: any field left out of the request is cleared, nested variations included. Requires idempotency_key; pass the same key to retry safely.
Risk: write
await corsair.square.api.catalog.upsert({
idempotency_key: '<idempotency key>',
object: { type: 'ITEM', id: '<id>' },
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). |
object | object | Yes | A CatalogObject to be created or updated. |
catalog.get first and send it back complete.
object full type
object full type
{
type: ITEM | IMAGE | CATEGORY | ITEM_VARIATION | TAX | DISCOUNT | MODIFIER_LIST | MODIFIER | PRICING_RULE | PRODUCT_SET | TIME_PERIOD | MEASUREMENT_UNIT | SUBSCRIPTION_PLAN_VARIATION | ITEM_OPTION | ITEM_OPTION_VAL | CUSTOM_ATTRIBUTE_DEFINITION | QUICK_AMOUNTS_SETTINGS | SUBSCRIPTION_PLAN | AVAILABILITY_PERIOD,
id: string,
updated_at?: string,
version?: number,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string,
type?: STRING | BOOLEAN | NUMBER | SELECTION,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id: string,
modifier_overrides?: {
modifier_id: string,
on_by_default?: boolean | null,
hidden_online_override?: NO | YES | NOT_SET,
on_by_default_override?: NO | YES | NOT_SET
}[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: NO | YES | NOT_SET,
is_conversational?: NO | YES | NOT_SET,
hidden_from_customer_override?: NO | YES | NOT_SET
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: REGULAR | GIFT_CARD | APPOINTMENTS_SERVICE | FOOD_AND_BEV | EVENT | DIGITAL | DONATION | LEGACY_SQUARE_ONLINE_SERVICE | LEGACY_SQUARE_ONLINE_MEMBERSHIP,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
},
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: {
type?: STANDARD | CUSTOM,
standard_name?: DAIRY_FREE | GLUTEN_FREE | HALAL | KOSHER | NUT_FREE | VEGAN | VEGETARIAN,
custom_name?: string | null
}[] | null,
ingredients?: {
type?: STANDARD | CUSTOM,
standard_name?: CELERY | CRUSTACEANS | EGGS | FISH | GLUTEN | LUPIN | MILK | MOLLUSCS | MUSTARD | PEANUTS | SESAME | SOY | SULPHITES | TREE_NUTS,
custom_name?: string | null
}[] | null
},
reporting_category?: {
id?: string,
ordinal?: number | null
},
is_alcoholic?: boolean | null
},
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: REGULAR_CATEGORY | MENU_CATEGORY | KITCHEN_CATEGORY,
parent_category?: {
id?: string,
ordinal?: number | null
},
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
},
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
},
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number,
pricing_type?: FIXED_PRICING | VARIABLE_PRICING,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pricing_type?: FIXED_PRICING | VARIABLE_PRICING,
track_inventory?: boolean | null,
inventory_alert_type?: NONE | LOW_QUANTITY,
inventory_alert_threshold?: number | null,
sold_out?: boolean,
sold_out_valid_until?: string
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: NONE | LOW_QUANTITY,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id: string,
stockable_quantity: string,
nonstockable_quantity: string
},
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null
},
tax_data?: {
name?: string | null,
calculation_phase?: TAX_SUBTOTAL_PHASE | TAX_TOTAL_PHASE,
inclusion_type?: ADDITIVE | INCLUSIVE,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
},
discount_data?: {
name?: string | null,
discount_type?: FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: MODIFY_TAX_BASIS | DO_NOT_MODIFY_TAX_BASIS,
maximum_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: SINGLE | MULTIPLE,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: LIST | TEXT,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
},
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
sold_out?: boolean
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
},
time_period_data?: {
event?: string | null
},
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
},
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: LEAST_EXPENSIVE | MOST_EXPENSIVE | MOST_EXPENSIVE_LOWEST_VALUE,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
customer_group_ids_any?: string[] | null
},
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
},
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null
},
subscription_plan_data?: {
name: string,
phases?: {
uid?: string | null,
cadence: DAILY | WEEKLY | EVERY_TWO_WEEKS | THIRTY_DAYS | SIXTY_DAYS | NINETY_DAYS | MONTHLY | EVERY_TWO_MONTHS | QUARTERLY | EVERY_FOUR_MONTHS | EVERY_SIX_MONTHS | ANNUAL | EVERY_TWO_YEARS,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ordinal?: number | null,
pricing?: {
type?: STATIC | RELATIVE,
discount_ids?: string[] | null,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
},
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
},
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
},
custom_attribute_definition_data?: {
type: STRING | BOOLEAN | NUMBER | SELECTION,
name: string,
description?: string | null,
source_application?: {
product?: SQUARE_POS | EXTERNAL_API | BILLING | APPOINTMENTS | INVOICES | ONLINE_STORE | PAYROLL | DASHBOARD | ITEM_LIBRARY_IMPORT | OTHER,
application_id?: string | null,
name?: string | null
},
allowed_object_types: (ITEM | IMAGE | CATEGORY | ITEM_VARIATION | TAX | DISCOUNT | MODIFIER_LIST | MODIFIER | PRICING_RULE | PRODUCT_SET | TIME_PERIOD | MEASUREMENT_UNIT | SUBSCRIPTION_PLAN_VARIATION | ITEM_OPTION | ITEM_OPTION_VAL | CUSTOM_ATTRIBUTE_DEFINITION | QUICK_AMOUNTS_SETTINGS | SUBSCRIPTION_PLAN | AVAILABILITY_PERIOD)[],
seller_visibility?: SELLER_VISIBILITY_HIDDEN | SELLER_VISIBILITY_READ_WRITE_VALUES,
app_visibility?: APP_VISIBILITY_HIDDEN | APP_VISIBILITY_READ_ONLY | APP_VISIBILITY_READ_WRITE_VALUES,
string_config?: {
enforce_uniqueness?: boolean | null
},
number_config?: {
precision?: number | null
},
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: {
uid?: string | null,
name: string
}[] | null
},
custom_attribute_usage_count?: number,
key?: string | null
},
quick_amounts_settings_data?: {
option: DISABLED | MANUAL | AUTO,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type: QUICK_AMOUNT_TYPE_MANUAL | QUICK_AMOUNT_TYPE_AUTO,
amount: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
score?: number | null,
ordinal?: number | null
}[] | null
},
subscription_plan_variation_data?: {
name: string,
phases: {
uid?: string | null,
cadence: DAILY | WEEKLY | EVERY_TWO_WEEKS | THIRTY_DAYS | SIXTY_DAYS | NINETY_DAYS | MONTHLY | EVERY_TWO_MONTHS | QUARTERLY | EVERY_FOUR_MONTHS | EVERY_SIX_MONTHS | ANNUAL | EVERY_TWO_YEARS,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ordinal?: number | null,
pricing?: {
type?: STATIC | RELATIVE,
discount_ids?: string[] | null,
price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[],
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
},
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: SUN | MON | TUE | WED | THU | FRI | SAT
}
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
catalog_object | object | null | No | — |
id_mappings | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
catalog_object full type
catalog_object full type
{
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
} | null
id_mappings full type
id_mappings full type
{
client_object_id?: string | null,
object_id?: string | null
}[] | null
Channels
bulkGet
channels.bulkGet
BulkRetrieveChannels. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.channels.bulkGet({
channel_ids: ['<channel ids>'],
});
| Name | Type | Required | Description |
|---|---|---|---|
channel_ids | string[] | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
responses | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
responses full type
responses full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
channel?: {
id?: string | null,
merchant_id?: string | null,
name?: string | null,
version?: number | null,
reference?: {
type?: string | null,
id?: string | null
} | null,
status?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
}> | null
get
channels.get
RetrieveChannel. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.channels.get({ channel_id: '<channel id>' });
| Name | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | A channel id |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
channel | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
channel full type
channel full type
{
id?: string | null,
merchant_id?: string | null,
name?: string | null,
version?: number | null,
reference?: {
type?: string | null,
id?: string | null
} | null,
status?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
list
channels.list
ListChannels. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.channels.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
reference_type | UNKNOWN_TYPE | LOCATION | FIRST_PARTY_INTEGRATION | OAUTH_APPLICATION | ONLINE_SITE | ONLINE_CHECKOUT | INVOICE | GIFT_CARD | GIFT_CARD_MARKETPLACE | RECURRING_SUBSCRIPTION | ONLINE_BOOKING_FLOW | SQUARE_ASSISTANT | CASH_LOCAL | POINT_OF_SALE | KIOSK | No | Type of reference associated to channel |
reference_id | string | No | id of reference associated to channel |
status | ACTIVE | INACTIVE | No | Status of channel |
cursor | string | No | Cursor to fetch the next result |
limit | number | No | Maximum number of results to return. When not provided the returned results will be cap at 100 channels. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
channels | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
channels full type
channels full type
{
id?: string | null,
merchant_id?: string | null,
name?: string | null,
version?: number | null,
reference?: {
type?: string | null,
id?: string | null
} | null,
status?: string | null,
created_at?: string | null,
updated_at?: string | null
}[] | null
Checkout
getLocationSettings
checkout.getLocationSettings
Retrieves the location-level settings for a Square-hosted checkout page. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.checkout.getLocationSettings({ location_id: '<location id>' });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the location for which to retrieve settings. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
location_settings | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location_settings full type
location_settings full type
{
location_id?: string | null,
customer_notes_enabled?: boolean | null,
policies?: {
uid?: string | null,
title?: string | null,
description?: string | null
}[] | null,
branding?: {
header_type?: string | null,
button_color?: string | null,
button_shape?: string | null
} | null,
tipping?: {
percentages?: number[] | null,
smart_tipping_enabled?: boolean | null,
default_percent?: number | null,
smart_tips?: {
amount?: number | null,
currency?: string | null
}[] | null,
default_smart_tip?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
coupons?: {
enabled?: boolean | null
} | null,
updated_at?: string | null
} | null
updateLocationSettings
checkout.updateLocationSettings
Updates the location-level settings for a Square-hosted checkout page. A policy’s title is required when setting its description. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.checkout.updateLocationSettings({
location_id: '<location id>',
location_settings: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
location_settings | object | Yes | Describe your updates using the location_settings object. Make sure it contains only the fields that have changed. |
location_id | string | Yes | The ID of the location for which to retrieve settings. |
location_settings full type
location_settings full type
{
location_id?: string | null,
customer_notes_enabled?: boolean | null,
policies?: {
uid?: string | null,
title?: string | null,
description?: string | null
}[] | null,
branding?: {
header_type?: BUSINESS_NAME | FRAMED_LOGO | FULL_WIDTH_LOGO,
button_color?: string | null,
button_shape?: SQUARED | ROUNDED | PILL
},
tipping?: {
percentages?: number[] | null,
smart_tipping_enabled?: boolean | null,
default_percent?: number | null,
smart_tips?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}[] | null,
default_smart_tip?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
coupons?: {
enabled?: boolean | null
},
updated_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
location_settings | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location_settings full type
location_settings full type
{
location_id?: string | null,
customer_notes_enabled?: boolean | null,
policies?: {
uid?: string | null,
title?: string | null,
description?: string | null
}[] | null,
branding?: {
header_type?: string | null,
button_color?: string | null,
button_shape?: string | null
} | null,
tipping?: {
percentages?: number[] | null,
smart_tipping_enabled?: boolean | null,
default_percent?: number | null,
smart_tips?: {
amount?: number | null,
currency?: string | null
}[] | null,
default_smart_tip?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
coupons?: {
enabled?: boolean | null
} | null,
updated_at?: string | null
} | null
Custom Attribute Definitions
customer.create
customAttributeDefinitions.customer.create
Creates a customer-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.customAttributeDefinitions.customer.create({
custom_attribute_definition: {
key: '<key>',
schema: { $ref: 'https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The custom attribute definition to create. |
idempotency_key | string | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key: string,
schema: Record<string, any>,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.delete
customAttributeDefinitions.customer.delete
Deletes a customer-related custom attribute definition from a Square seller account. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.customAttributeDefinitions.customer.delete({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.get
customAttributeDefinitions.customer.get
Retrieves a customer-related custom attribute definition from a Square seller account.
Risk: read
await corsair.square.api.customAttributeDefinitions.customer.get({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key. |
version | number | No | The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.list
customAttributeDefinitions.customer.list
Lists the customer-related custom attribute definitions that belong to a Square seller account.
Risk: read
await corsair.square.api.customAttributeDefinitions.customer.list({ limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definitions | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definitions full type
custom_attribute_definitions full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.update
customAttributeDefinitions.customer.update
Updates a customer-related custom attribute definition for a Square seller account. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.customAttributeDefinitions.customer.update({
key: '<key>',
custom_attribute_definition: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, so only new or changed fields need to be included in the request. |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
key | string | Yes | The key of the custom attribute definition to update. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.create
customAttributeDefinitions.location.create
Creates a location-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributeDefinitions.location.create({
custom_attribute_definition: {
key: '<key>',
schema: { $ref: 'https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The custom attribute definition to create. |
idempotency_key | string | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key: string,
schema: Record<string, any>,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.delete
customAttributeDefinitions.location.delete
Deletes a location-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributeDefinitions.location.delete({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.get
customAttributeDefinitions.location.get
Retrieves a location-related custom attribute definition from a Square seller account. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributeDefinitions.location.get({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key. |
version | number | No | The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.list
customAttributeDefinitions.location.list
Lists the location-related custom attribute definitions that belong to a Square seller account. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributeDefinitions.location.list({ limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
visibility_filter | ALL | READ | READ_WRITE | No | Filters the CustomAttributeDefinition results by their visibility values. |
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definitions | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definitions full type
custom_attribute_definitions full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.update
customAttributeDefinitions.location.update
Updates a location-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description, visibility, or the schema for a Selection data type. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributeDefinitions.location.update({
key: '<key>',
custom_attribute_definition: { description: '<description>', version: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The fields to change (sparse update) plus the current version of the definition. |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
key | string | Yes | The key of the custom attribute definition to update. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.create
customAttributeDefinitions.merchant.create
Creates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributeDefinitions.merchant.create({
custom_attribute_definition: {
key: '<key>',
schema: { $ref: 'https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The custom attribute definition to create. |
idempotency_key | string | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key: string,
schema: Record<string, any>,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.delete
customAttributeDefinitions.merchant.delete
Deletes a merchant-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from the merchant. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributeDefinitions.merchant.delete({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.get
customAttributeDefinitions.merchant.get
Retrieves a merchant-related custom attribute definition from a Square seller account. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributeDefinitions.merchant.get({ key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key. |
version | number | No | The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.list
customAttributeDefinitions.merchant.list
Lists the merchant-related custom attribute definitions that belong to a Square seller account. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributeDefinitions.merchant.list({ limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
visibility_filter | ALL | READ | READ_WRITE | No | Filters the CustomAttributeDefinition results by their visibility values. |
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definitions | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definitions full type
custom_attribute_definitions full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.update
customAttributeDefinitions.merchant.update
Updates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description, visibility, or the schema for a Selection data type. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributeDefinitions.merchant.update({
key: '<key>',
custom_attribute_definition: { description: '<description>', version: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | Yes | The fields to change (sparse update) plus the current version of the definition. |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
key | string | Yes | The key of the custom attribute definition to update. |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version: number,
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute_definition | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute_definition full type
custom_attribute_definition full type
{
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Custom Attributes
customer.bulkUpsert
customAttributes.customer.bulkUpsert
Creates or updates custom attributes for customer profiles as a bulk operation.
Risk: write
await corsair.square.api.customAttributes.customer.bulkUpsert({
values: {
example: {
customer_id: '<customer id>',
custom_attribute: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
values | object | Yes | A map containing 1 to 25 individual upsert requests. |
values full type
values full type
Record<string, {
customer_id: string,
custom_attribute: {
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
},
idempotency_key?: string | null
}>
| Name | Type | Required | Description |
|---|---|---|---|
values | object | null | No | — |
errors | object[] | null | No | — |
values full type
values full type
Record<string, {
customer_id?: string | null,
custom_attribute?: {
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.delete
customAttributes.customer.delete
Deletes a custom attribute associated with a customer profile. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.customAttributes.customer.delete({ customer_id: '<customer id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the target customer profile. |
key | string | Yes | The key of the custom attribute to delete. This key must match the key of a custom attribute definition in the Square seller account. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.get
customAttributes.customer.get
Retrieves a custom attribute associated with a customer profile.
Risk: read
await corsair.square.api.customAttributes.customer.get({ customer_id: '<customer id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the target customer profile. |
key | string | Yes | The key of the custom attribute to retrieve. This key must match the key of a custom attribute definition in the Square seller account. |
with_definition | boolean | No | Indicates whether to return the custom attribute definition in the definition field of the custom attribute. |
version | number | No | The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.list
customAttributes.customer.list
Lists the custom attributes associated with a customer profile.
Risk: read
await corsair.square.api.customAttributes.customer.list({ customer_id: '<customer id>', limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the target customer profile. |
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
with_definitions | boolean | No | Indicates whether to return the custom attribute definition in the definition field of each custom attribute. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attributes | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attributes full type
custom_attributes full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer.upsert
customAttributes.customer.upsert
Creates or updates a custom attribute for a customer profile. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.customAttributes.customer.upsert({
customer_id: '<customer id>',
key: '<key>',
custom_attribute: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | Yes | The custom attribute to create or update, with the following fields: |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
customer_id | string | Yes | The ID of the target customer profile. |
key | string | Yes | The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.bulkDelete
customAttributes.location.bulkDelete
Deletes custom attributes for locations as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributes.location.bulkDelete({
values: {
example: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
values | object | Yes | The data used to update the CustomAttribute objects. The keys must be unique and are used to map to the corresponding response. |
values full type
values full type
Record<string, {
key?: string,
location_id?: string
}>
| Name | Type | Required | Description |
|---|---|---|---|
values | object | null | No | — |
errors | object[] | null | No | — |
values full type
values full type
Record<string, {
location_id?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.bulkUpsert
customAttributes.location.bulkUpsert
Creates or updates custom attributes for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributes.location.bulkUpsert({
values: {
example: {
location_id: '<location id>',
custom_attribute: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
values | object | Yes | A map containing 1 to 25 individual upsert requests. |
values full type
values full type
Record<string, {
location_id: string,
custom_attribute: {
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
},
idempotency_key?: string | null
}>
| Name | Type | Required | Description |
|---|---|---|---|
values | object | null | No | — |
errors | object[] | null | No | — |
values full type
values full type
Record<string, {
location_id?: string | null,
custom_attribute?: {
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.delete
customAttributes.location.delete
Deletes a custom attribute associated with a location. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributes.location.delete({ location_id: '<location id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the target location. |
key | string | Yes | The key of the custom attribute to delete. This key must match the key of a custom attribute definition in the Square seller account. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.get
customAttributes.location.get
Retrieves a custom attribute associated with a location. You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributes.location.get({ location_id: '<location id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the target location. |
key | string | Yes | The key of the custom attribute to retrieve. This key must match the key of a custom attribute definition in the Square seller account. |
with_definition | boolean | No | Indicates whether to return the custom attribute definition in the definition field of the custom attribute. |
version | number | No | The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.list
customAttributes.location.list
Lists the custom attributes associated with a location. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributes.location.list({ location_id: '<location id>', limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the target location. |
visibility_filter | ALL | READ | READ_WRITE | No | Filters the CustomAttributeDefinition results by their visibility values. |
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
with_definitions | boolean | No | Indicates whether to return the custom attribute definition in the definition field of each custom attribute. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attributes | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attributes full type
custom_attributes full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location.upsert
customAttributes.location.upsert
Creates or updates a custom attribute for a location. Use this endpoint to set the value of a custom attribute for a specified location. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributes.location.upsert({
location_id: '<location id>',
key: '<key>',
custom_attribute: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | Yes | The custom attribute to create or update, with the following fields: - value. This value must conform to the schema specified by the definition. |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
location_id | string | Yes | The ID of the target location. |
key | string | Yes | The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.bulkDelete
customAttributes.merchant.bulkDelete
Deletes custom attributes for a merchant as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributes.merchant.bulkDelete({
values: {
example: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
values | object | Yes | The data used to update the CustomAttribute objects. The keys must be unique and are used to map to the corresponding response. |
values full type
values full type
Record<string, {
key?: string,
merchant_id?: string
}>
| Name | Type | Required | Description |
|---|---|---|---|
values | object | null | No | — |
errors | object[] | null | No | — |
values full type
values full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.bulkUpsert
customAttributes.merchant.bulkUpsert
Creates or updates custom attributes for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributes.merchant.bulkUpsert({
values: {
example: {
merchant_id: '<merchant id>',
custom_attribute: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
values | object | Yes | A map containing 1 to 25 individual upsert requests. |
values full type
values full type
Record<string, {
merchant_id: string,
custom_attribute: {
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
},
idempotency_key?: string | null
}>
| Name | Type | Required | Description |
|---|---|---|---|
values | object | null | No | — |
errors | object[] | null | No | — |
values full type
values full type
Record<string, {
merchant_id?: string | null,
custom_attribute?: {
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.delete
customAttributes.merchant.delete
Deletes a custom attribute associated with a merchant. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change.
Risk: destructive · Irreversible
await corsair.square.api.customAttributes.merchant.delete({ merchant_id: '<merchant id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
merchant_id | string | Yes | The ID of the target merchant. |
key | string | Yes | The key of the custom attribute to delete. This key must match the key of a custom attribute definition in the Square seller account. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.get
customAttributes.merchant.get
Retrieves a custom attribute associated with a merchant. You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributes.merchant.get({ merchant_id: '<merchant id>', key: '<key>' });
| Name | Type | Required | Description |
|---|---|---|---|
merchant_id | string | Yes | The ID of the target merchant. |
key | string | Yes | The key of the custom attribute to retrieve. This key must match the key of a custom attribute definition in the Square seller account. |
with_definition | boolean | No | Indicates whether to return the custom attribute definition in the definition field of the custom attribute. |
version | number | No | The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.list
customAttributes.merchant.list
Lists the custom attributes associated with a merchant. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.customAttributes.merchant.list({ merchant_id: '<merchant id>', limit: 1, cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
merchant_id | string | Yes | The ID of the target merchant. |
visibility_filter | ALL | READ | READ_WRITE | No | Filters the CustomAttributeDefinition results by their visibility values. |
limit | number | No | The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. |
cursor | string | No | The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. |
with_definitions | boolean | No | Indicates whether to return the custom attribute definition in the definition field of each custom attribute. |
| Name | Type | Required | Description |
|---|---|---|---|
custom_attributes | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
custom_attributes full type
custom_attributes full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant.upsert
customAttributes.merchant.upsert
Creates or updates a custom attribute for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.customAttributes.merchant.upsert({
merchant_id: '<merchant id>',
key: '<key>',
custom_attribute: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | Yes | The custom attribute to create or update, with the following fields: - value. This value must conform to the schema specified by the definition. |
idempotency_key | string | null | No | A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. |
merchant_id | string | Yes | The ID of the target merchant. |
key | string | Yes | The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: VISIBILITY_HIDDEN | VISIBILITY_READ_ONLY | VISIBILITY_READ_WRITE_VALUES,
version?: number,
updated_at?: string,
created_at?: string
},
updated_at?: string,
created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
custom_attribute | object | null | No | — |
errors | object[] | null | No | — |
custom_attribute full type
custom_attribute full type
{
key?: string | null,
value?: JsonValue | null,
version?: number | null,
visibility?: string | null,
definition?: {
key?: string | null,
schema?: Record<string, any> | null,
name?: string | null,
description?: string | null,
visibility?: string | null,
version?: number | null,
updated_at?: string | null,
created_at?: string | null
} | null,
updated_at?: string | null,
created_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Customer Groups
create
customerGroups.create
Creates a new customer group for a business. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.customerGroups.create({
group: { name: '<name>' },
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | No | The idempotency key for the request. For more information, see Idempotency. |
group | object | Yes | The customer group to create. |
group full type
group full type
{
id?: string,
name: string,
created_at?: string,
updated_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
group | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
group full type
group full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
delete
customerGroups.delete
Deletes a customer group as identified by the group_id value. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.customerGroups.delete({ group_id: '<group id>' });
| Name | Type | Required | Description |
|---|---|---|---|
group_id | string | Yes | The ID of the customer group to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
customerGroups.get
Retrieves a specific customer group as identified by the group_id value.
Risk: read
await corsair.square.api.customerGroups.get({ group_id: '<group id>' });
| Name | Type | Required | Description |
|---|---|---|---|
group_id | string | Yes | The ID of the customer group to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
group | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
group full type
group full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
list
customerGroups.list
Retrieves the list of customer groups of a business.
Risk: read
await corsair.square.api.customerGroups.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. |
limit | number | No | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
groups | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
groups full type
groups full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
}[] | null
update
customerGroups.update
Updates a customer group as identified by the group_id value.
Risk: write
await corsair.square.api.customerGroups.update({
group_id: '<group id>',
group: { name: '<name>' },
});
| Name | Type | Required | Description |
|---|---|---|---|
group | object | Yes | The CustomerGroup object including all the updates you want to make. |
group_id | string | Yes | The ID of the customer group to update. |
group full type
group full type
{
id?: string,
name: string,
created_at?: string,
updated_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
group | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
group full type
group full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
Customers
addGroup
customers.addGroup
Adds a group membership to a customer.
Risk: write
await corsair.square.api.customers.addGroup({ customer_id: '<customer id>', group_id: '<group id>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the customer to add to a group. |
group_id | string | Yes | The ID of the customer group to add the customer to. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
bulkCreate
customers.bulkCreate
Creates multiple customer profiles for a business.
Risk: write
await corsair.square.api.customers.bulkCreate({
customers: {
example: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
customers | object | Yes | A map of 1 to 100 individual create requests, represented by idempotency key: { customer data } key-value pairs. |
customers full type
customers full type
Record<string, {
given_name?: string | null,
family_name?: string | null,
company_name?: string | null,
nickname?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
phone_number?: string | null,
reference_id?: string | null,
note?: string | null,
birthday?: string | null,
tax_ids?: {
eu_vat?: string | null
}
}>
| Name | Type | Required | Description |
|---|---|---|---|
responses | object | null | No | — |
errors | object[] | null | No | — |
responses full type
responses full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
customer?: {
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
bulkDelete
customers.bulkDelete
Deletes multiple customer profiles. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.customers.bulkDelete({
customer_ids: ['<customer ids>'],
});
| Name | Type | Required | Description |
|---|---|---|---|
customer_ids | string[] | Yes | The IDs of the customer profiles to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
responses | object | null | No | — |
errors | object[] | null | No | — |
responses full type
responses full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
bulkGet
customers.bulkGet
Retrieves multiple customer profiles.
Risk: read
await corsair.square.api.customers.bulkGet({
customer_ids: ['<customer ids>'],
});
| Name | Type | Required | Description |
|---|---|---|---|
customer_ids | string[] | Yes | The IDs of the customer profiles to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
responses | object | null | No | — |
errors | object[] | null | No | — |
responses full type
responses full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
customer?: {
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
bulkUpdate
customers.bulkUpdate
Updates multiple customer profiles.
Risk: write
await corsair.square.api.customers.bulkUpdate({
customers: {
example: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
customers | object | Yes | A map of 1 to 100 individual update requests, represented by customer ID: { customer data } key-value pairs. |
customers full type
customers full type
Record<string, {
given_name?: string | null,
family_name?: string | null,
company_name?: string | null,
nickname?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
phone_number?: string | null,
reference_id?: string | null,
note?: string | null,
birthday?: string | null,
tax_ids?: {
eu_vat?: string | null
},
version?: number
}>
| Name | Type | Required | Description |
|---|---|---|---|
responses | object | null | No | — |
errors | object[] | null | No | — |
responses full type
responses full type
Record<string, {
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
customer?: {
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
}> | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
create
customers.create
Creates a new customer for a business. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.customers.create({ given_name: 'Ada', family_name: 'Lovelace', email_address: 'ada@example.com' });
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | No | The idempotency key for the request. For more information, see Idempotency. |
given_name | string | No | The given name (that is, the first name) associated with the customer profile. |
family_name | string | No | The family name (that is, the last name) associated with the customer profile. |
company_name | string | No | A business name associated with the customer profile. |
nickname | string | No | A nickname for the customer profile. |
email_address | string | No | The email address associated with the customer profile. |
address | object | No | The physical address associated with the customer profile. For maximum length constraints, see Customer addresses. |
phone_number | string | No | The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional + prefix and country code. |
reference_id | string | No | An optional second ID used to associate the customer profile with an entity in another system. |
note | string | No | A custom note associated with the customer profile. |
birthday | string | No | The birthday associated with the customer profile, in YYYY-MM-DD or MM-DD format. For example, specify 1998-09-21 for September 21, 1998, or 09-21 for September 21. |
tax_ids | object | No | The tax ID associated with the customer profile. This field is available only for customers of sellers in EU countries or the United Kingdom. |
address full type
address full type
{
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
tax_ids full type
tax_ids full type
{
eu_vat?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
customer | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer full type
customer full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
delete
customers.delete
Deletes a customer profile from a business. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.customers.delete({ customer_id: '<customer id>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the customer to delete. |
version | number | No | The current version of the customer profile. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
customers.get
Returns details for a single customer.
Risk: read
await corsair.square.api.customers.get({ customer_id: '<customer id>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the customer to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
customer | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer full type
customer full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
list
customers.list
Lists customer profiles associated with a Square account.
Risk: read
await corsair.square.api.customers.list({ limit: 25 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. |
limit | number | No | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. |
sort_field | DEFAULT | CREATED_AT | No | Indicates how customers should be sorted. |
sort_order | DESC | ASC | No | Indicates whether customers should be sorted in ascending (ASC) or descending (DESC) order. |
count | boolean | No | Indicates whether to return the total count of customers in the count field of the response. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
customers | object[] | null | No | — |
cursor | string | null | No | — |
count | number | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customers full type
customers full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
}[] | null
removeGroup
customers.removeGroup
Removes a group membership from a customer.
Risk: write
await corsair.square.api.customers.removeGroup({ customer_id: '<customer id>', group_id: '<group id>' });
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The ID of the customer to remove from the group. |
group_id | string | Yes | The ID of the customer group to remove the customer from. |
DELETE, but classified as a write: customers.addGroup puts the customer back in the group.
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
search
customers.search
Searches the customer profiles associated with a Square account using one or more supported query filters.
Risk: read
await corsair.square.api.customers.search({
query: {
filter: {
email_address: { exact: 'ada@example.com' },
},
},
limit: 10,
});
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. |
limit | number | No | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. |
query | object | No | The filtering and sorting criteria for the search request. |
count | boolean | No | Indicates whether to return the total count of matching customers in the count field of the response. |
query full type
query full type
{
filter?: {
creation_source?: {
values?: (OTHER | APPOINTMENTS | COUPON | DELETION_RECOVERY | DIRECTORY | EGIFTING | EMAIL_COLLECTION | FEEDBACK | IMPORT | INVOICES | LOYALTY | MARKETING | MERGE | ONLINE_STORE | INSTANT_PROFILE | TERMINAL | THIRD_PARTY | THIRD_PARTY_IMPORT | UNMERGE_RECOVERY)[] | null,
rule?: INCLUDE | EXCLUDE
},
created_at?: {
start_at?: string | null,
end_at?: string | null
},
updated_at?: {
start_at?: string | null,
end_at?: string | null
},
email_address?: {
exact?: string | null,
fuzzy?: string | null
},
phone_number?: {
exact?: string | null,
fuzzy?: string | null
},
reference_id?: {
exact?: string | null,
fuzzy?: string | null
},
group_ids?: {
all?: string[] | null,
any?: string[] | null,
none?: string[] | null
},
custom_attribute?: {
filters?: {
key: string,
filter?: Record<string, any>,
updated_at?: {
start_at?: string | null,
end_at?: string | null
}
}[] | null
},
segment_ids?: {
all?: string[] | null,
any?: string[] | null,
none?: string[] | null
}
},
sort?: {
field?: DEFAULT | CREATED_AT,
order?: DESC | ASC
}
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
customers | object[] | null | No | — |
cursor | string | null | No | — |
count | number | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customers full type
customers full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
}[] | null
update
customers.update
Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field, specify the new value. To remove a field, specify null.
Risk: write
await corsair.square.api.customers.update({ customer_id: '<customer id>' });
| Name | Type | Required | Description |
|---|---|---|---|
given_name | string | null | No | The given name (that is, the first name) associated with the customer profile. |
family_name | string | null | No | The family name (that is, the last name) associated with the customer profile. |
company_name | string | null | No | A business name associated with the customer profile. |
nickname | string | null | No | A nickname for the customer profile. |
email_address | string | null | No | The email address associated with the customer profile. |
address | object | null | No | The physical address associated with the customer profile. Only new or changed fields are required in the request. |
phone_number | string | null | No | The phone number associated with the customer profile. The phone number must be valid and can contain 9–16 digits, with an optional + prefix and country code. |
reference_id | string | null | No | An optional second ID used to associate the customer profile with an entity in another system. |
note | string | null | No | A custom note associated with the customer profile. |
birthday | string | null | No | The birthday associated with the customer profile, in YYYY-MM-DD or MM-DD format. For example, specify 1998-09-21 for September 21, 1998, or 09-21 for September 21. |
version | number | No | The current version of the customer profile. |
tax_ids | object | null | No | The tax ID associated with the customer profile. This field is available only for customers of sellers in EU countries or the United Kingdom. |
customer_id | string | Yes | The ID of the customer to update. |
address full type
address full type
{
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
} | null
tax_ids full type
tax_ids full type
{
eu_vat?: string | null
} | null
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
customer | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
customer full type
customer full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
given_name?: string | null,
family_name?: string | null,
nickname?: string | null,
company_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
birthday?: string | null,
reference_id?: string | null,
note?: string | null,
preferences?: {
email_unsubscribed?: boolean | null
} | null,
creation_source?: string | null,
group_ids?: string[] | null,
segment_ids?: string[] | null,
version?: number | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null
Customer Segments
get
customerSegments.get
Retrieves a specific customer segment as identified by the segment_id value.
Risk: read
await corsair.square.api.customerSegments.get({ segment_id: '<segment id>' });
| Name | Type | Required | Description |
|---|---|---|---|
segment_id | string | Yes | The Square-issued ID of the customer segment. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
segment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
segment full type
segment full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
list
customerSegments.list
Retrieves the list of customer segments of a business.
Risk: read
await corsair.square.api.customerSegments.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by previous calls to ListCustomerSegments. This cursor is used to retrieve the next set of query results. |
limit | number | No | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
segments | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
segments full type
segments full type
{
id?: string | null,
name?: string | null,
created_at?: string | null,
updated_at?: string | null
}[] | null
Disputes
accept
disputes.accept
Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Moves money. Square takes no idempotency_key here; disputes.get shows whether the dispute is already accepted before you repeat the call. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.disputes.accept({ dispute_id: '<dispute id>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute you want to accept. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
dispute | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
dispute full type
dispute full type
{
dispute_id?: string | null,
id?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
reason?: string | null,
state?: string | null,
due_at?: string | null,
disputed_payment?: {
payment_id?: string | null
} | null,
evidence_ids?: string[] | null,
card_brand?: string | null,
created_at?: string | null,
updated_at?: string | null,
brand_dispute_id?: string | null,
reported_date?: string | null,
reported_at?: string | null,
version?: number | null,
location_id?: string | null
} | null
createEvidenceFile
disputes.createEvidenceFile
Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. Requires idempotency_key; pass the same key to retry safely.
Risk: write
await corsair.square.api.disputes.createEvidenceFile({
dispute_id: '<dispute id>',
idempotency_key: '<idempotency key>',
file_base64: '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAP//////////////////////////////////////////////////////////////////////////////////////wgALCAABAAEBAREA/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPxA=',
filename: 'receipt.jpg',
content_type: 'image/jpeg',
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A unique key identifying the request. For more information, see Idempotency. |
evidence_type | GENERIC_EVIDENCE | ONLINE_OR_APP_ACCESS_LOG | AUTHORIZATION_DOCUMENTATION | CANCELLATION_OR_REFUND_DOCUMENTATION | CARDHOLDER_COMMUNICATION | CARDHOLDER_INFORMATION | PURCHASE_ACKNOWLEDGEMENT | DUPLICATE_CHARGE_DOCUMENTATION | PRODUCT_OR_SERVICE_DESCRIPTION | RECEIPT | SERVICE_RECEIVED_DOCUMENTATION | PROOF_OF_DELIVERY_DOCUMENTATION | RELATED_TRANSACTION_DOCUMENTATION | REBUTTAL_EXPLANATION | TRACKING_NUMBER | No | The type of evidence you are uploading. See DisputeEvidenceType for possible values |
content_type | string | No | The MIME type of the uploaded file. The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff. |
dispute_id | string | Yes | The ID of the dispute for which you want to upload evidence. |
file_base64 | string | Yes | The file’s bytes, base64-encoded (standard or URL-safe; a data: URL prefix is accepted). |
filename | string | No | File name sent with the upload, for example receipt.jpg. Defaults to attachment plus the extension of the content type. |
file_base64 is the file; content_type (in the JSON request field) is its MIME type. Sent as multipart: request is a plain form field and the file is in image_file.
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
evidence | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
evidence full type
evidence full type
{
evidence_id?: string | null,
id?: string | null,
dispute_id?: string | null,
evidence_file?: {
filename?: string | null,
filetype?: string | null
} | null,
evidence_text?: string | null,
uploaded_at?: string | null,
evidence_type?: string | null
} | null
createEvidenceText
disputes.createEvidenceText
Uploads text to use as evidence for a dispute challenge. Requires idempotency_key; pass the same key to retry safely.
Risk: write
await corsair.square.api.disputes.createEvidenceText({ dispute_id: '<dispute id>', idempotency_key: '<idempotency key>', evidence_text: '<evidence text>' });
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A unique key identifying the request. For more information, see Idempotency. |
evidence_type | GENERIC_EVIDENCE | ONLINE_OR_APP_ACCESS_LOG | AUTHORIZATION_DOCUMENTATION | CANCELLATION_OR_REFUND_DOCUMENTATION | CARDHOLDER_COMMUNICATION | CARDHOLDER_INFORMATION | PURCHASE_ACKNOWLEDGEMENT | DUPLICATE_CHARGE_DOCUMENTATION | PRODUCT_OR_SERVICE_DESCRIPTION | RECEIPT | SERVICE_RECEIVED_DOCUMENTATION | PROOF_OF_DELIVERY_DOCUMENTATION | RELATED_TRANSACTION_DOCUMENTATION | REBUTTAL_EXPLANATION | TRACKING_NUMBER | No | The type of evidence you are uploading. See DisputeEvidenceType for possible values |
evidence_text | string | Yes | The evidence string. |
dispute_id | string | Yes | The ID of the dispute for which you want to upload evidence. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
evidence | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
evidence full type
evidence full type
{
evidence_id?: string | null,
id?: string | null,
dispute_id?: string | null,
evidence_file?: {
filename?: string | null,
filetype?: string | null
} | null,
evidence_text?: string | null,
uploaded_at?: string | null,
evidence_type?: string | null
} | null
deleteEvidence
disputes.deleteEvidence
Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.disputes.deleteEvidence({ dispute_id: '<dispute id>', evidence_id: '<evidence id>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute from which you want to remove evidence. |
evidence_id | string | Yes | The ID of the evidence you want to remove. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
disputes.get
Returns details about a specific dispute.
Risk: read
await corsair.square.api.disputes.get({ dispute_id: '<dispute id>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute you want more details about. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
dispute | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
dispute full type
dispute full type
{
dispute_id?: string | null,
id?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
reason?: string | null,
state?: string | null,
due_at?: string | null,
disputed_payment?: {
payment_id?: string | null
} | null,
evidence_ids?: string[] | null,
card_brand?: string | null,
created_at?: string | null,
updated_at?: string | null,
brand_dispute_id?: string | null,
reported_date?: string | null,
reported_at?: string | null,
version?: number | null,
location_id?: string | null
} | null
getEvidence
disputes.getEvidence
Returns the metadata for the evidence specified in the request URL path.
Risk: read
await corsair.square.api.disputes.getEvidence({ dispute_id: '<dispute id>', evidence_id: '<evidence id>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute from which you want to retrieve evidence metadata. |
evidence_id | string | Yes | The ID of the evidence to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
evidence | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
evidence full type
evidence full type
{
evidence_id?: string | null,
id?: string | null,
dispute_id?: string | null,
evidence_file?: {
filename?: string | null,
filetype?: string | null
} | null,
evidence_text?: string | null,
uploaded_at?: string | null,
evidence_type?: string | null
} | null
list
disputes.list
Returns a list of disputes associated with a particular account.
Risk: read
await corsair.square.api.disputes.list({ cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. |
states | INQUIRY_EVIDENCE_REQUIRED | INQUIRY_PROCESSING | INQUIRY_CLOSED | EVIDENCE_REQUIRED | PROCESSING | WON | LOST | ACCEPTED | No | The dispute states used to filter the result. If not specified, the endpoint returns all disputes. |
location_id | string | No | The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
disputes | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
disputes full type
disputes full type
{
dispute_id?: string | null,
id?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
reason?: string | null,
state?: string | null,
due_at?: string | null,
disputed_payment?: {
payment_id?: string | null
} | null,
evidence_ids?: string[] | null,
card_brand?: string | null,
created_at?: string | null,
updated_at?: string | null,
brand_dispute_id?: string | null,
reported_date?: string | null,
reported_at?: string | null,
version?: number | null,
location_id?: string | null
}[] | null
listEvidence
disputes.listEvidence
Returns a list of evidence associated with a dispute.
Risk: read
await corsair.square.api.disputes.listEvidence({ dispute_id: '<dispute id>', cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute. |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. |
| Name | Type | Required | Description |
|---|---|---|---|
evidence | object[] | null | No | — |
errors | object[] | null | No | — |
cursor | string | null | No | — |
evidence full type
evidence full type
{
evidence_id?: string | null,
id?: string | null,
dispute_id?: string | null,
evidence_file?: {
filename?: string | null,
filetype?: string | null
} | null,
evidence_text?: string | null,
uploaded_at?: string | null,
evidence_type?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
submitEvidence
disputes.submitEvidence
Submits evidence to the cardholder’s bank. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.disputes.submitEvidence({ dispute_id: '<dispute id>' });
| Name | Type | Required | Description |
|---|---|---|---|
dispute_id | string | Yes | The ID of the dispute for which you want to submit evidence. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
dispute | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
dispute full type
dispute full type
{
dispute_id?: string | null,
id?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
reason?: string | null,
state?: string | null,
due_at?: string | null,
disputed_payment?: {
payment_id?: string | null
} | null,
evidence_ids?: string[] | null,
card_brand?: string | null,
created_at?: string | null,
updated_at?: string | null,
brand_dispute_id?: string | null,
reported_date?: string | null,
reported_at?: string | null,
version?: number | null,
location_id?: string | null
} | null
Inventory
batchGet
inventory.batchGet
Returns current counts for the provided CatalogObjects at the requested Locations.
Risk: read
await corsair.square.api.inventory.batchGet({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
catalog_object_ids | string[] | null | No | The filter to return results by CatalogObject ID. The filter is applicable only when set. The default is null. |
location_ids | string[] | null | No | The filter to return results by Location ID. This filter is applicable only when set. The default is null. |
updated_after | string | null | No | The filter to return results with their calculated_at value after the given time as specified in an RFC 3339 timestamp. |
cursor | string | null | No | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. |
states | (CUSTOM | IN_STOCK | SOLD | RETURNED_BY_CUSTOMER | RESERVED_FOR_SALE | SOLD_ONLINE | ORDERED_FROM_VENDOR | RECEIVED_FROM_VENDOR | IN_TRANSIT_TO | NONE | WASTE | UNLINKED_RETURN | COMPOSED | DECOMPOSED | SUPPORTED_BY_NEWER_VERSION | IN_TRANSIT | UNTRACKED)[] | null | No | The filter to return results by InventoryState. The filter is only applicable when set. Ignored are untracked states of NONE, SOLD, and UNLINKED_RETURN. |
limit | number | null | No | The number of records to return. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
counts | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
counts full type
counts full type
{
catalog_object_id?: string | null,
catalog_object_type?: string | null,
state?: string | null,
location_id?: string | null,
quantity?: string | null,
calculated_at?: string | null,
is_estimated?: boolean | null
}[] | null
get
inventory.get
Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.
Risk: read
await corsair.square.api.inventory.get({ catalog_object_id: '<catalog object id>', cursor: '<cursor>' });
| Name | Type | Required | Description |
|---|---|---|---|
catalog_object_id | string | Yes | ID of the CatalogObject to retrieve. |
location_ids | string | No | The Location IDs to look up as a comma-separated list. An empty list queries all locations. |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
counts | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
counts full type
counts full type
{
catalog_object_id?: string | null,
catalog_object_type?: string | null,
state?: string | null,
location_id?: string | null,
quantity?: string | null,
calculated_at?: string | null,
is_estimated?: boolean | null
}[] | null
Invoices
cancel
invoices.cancel
Cancels an invoice. The seller cannot collect payments for the canceled invoice. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.invoices.cancel({ invoice_id: '<invoice id>', version: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
version | number | Yes | The version of the invoice to cancel. If you do not know the version, you can call GetInvoice or ListInvoices. |
invoice_id | string | Yes | The ID of the invoice to cancel. |
version from invoices.get; every committed change, including adding or removing an attachment, increments it.
Output
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | null | No | — |
errors | object[] | null | No | — |
invoice full type
invoice full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
create
invoices.create
Creates a draft invoice for an order created using the Orders API. Give delivery_method (recommended) or the deprecated request_method on each payment request; the schema does not require delivery_method for that reason. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.invoices.create({
invoice: {
order_id: '<order id>',
payment_requests: [{ request_type: 'BALANCE', due_date: '2026-11-30' }],
accepted_payment_methods: { card: true },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | Yes | The invoice to create. |
idempotency_key | string | No | A unique string that identifies the CreateInvoice request. |
invoice full type
invoice full type
{
id?: string,
version?: number,
location_id?: string | null,
order_id: string,
primary_recipient?: {
customer_id?: string | null,
given_name?: string,
family_name?: string,
email_address?: string,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
phone_number?: string,
company_name?: string,
tax_ids?: {
eu_vat?: string
}
},
payment_requests: {
uid?: string | null,
request_method?: EMAIL | CHARGE_CARD_ON_FILE | SHARE_MANUALLY | CHARGE_BANK_ON_FILE | SMS | SMS_CHARGE_CARD_ON_FILE | SMS_CHARGE_BANK_ON_FILE,
request_type: BALANCE | DEPOSIT | INSTALLMENT,
due_date: string,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: NONE | CARD_ON_FILE | BANK_ON_FILE,
card_id?: string | null,
reminders?: {
uid?: string,
relative_scheduled_days?: number | null,
message?: string | null,
status?: PENDING | NOT_APPLICABLE | SENT,
sent_at?: string
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_completed_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[],
delivery_method?: EMAIL | SHARE_MANUALLY | SMS,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string,
next_payment_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status?: DRAFT | UNPAID | SCHEDULED | PARTIALLY_PAID | PAID | PARTIALLY_REFUNDED | REFUNDED | CANCELED | FAILED | PAYMENT_PENDING,
timezone?: string,
created_at?: string,
updated_at?: string,
accepted_payment_methods: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
},
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: ABOVE_LINE_ITEMS | BELOW_LINE_ITEMS
}[] | null,
subscription_id?: string,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string,
filename?: string,
description?: string,
filesize?: number,
hash?: string,
mime_type?: string,
uploaded_at?: string
}[],
creator_team_member_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | null | No | — |
errors | object[] | null | No | — |
invoice full type
invoice full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
createAttachment
invoices.createAttachment
Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads with a JSON request part and a file part. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Pass the same idempotency_key to retry safely.
Risk: destructive
await corsair.square.api.invoices.createAttachment({
invoice_id: '<invoice id>',
file_base64: '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAP//////////////////////////////////////////////////////////////////////////////////////wgALCAABAAEBAREA/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPxA=',
filename: 'receipt.jpg',
content_type: 'image/jpeg',
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | No | A unique string that identifies the CreateInvoiceAttachment request. For more information, see Idempotency. |
description | string | No | The description of the attachment to display on the invoice. |
invoice_id | string | Yes | The ID of the invoice to attach the file to. |
file_base64 | string | Yes | The file’s bytes, base64-encoded (standard or URL-safe; a data: URL prefix is accepted). |
filename | string | No | File name sent with the upload, for example receipt.jpg. Defaults to attachment plus the extension of the content type. |
content_type | string | No | MIME type of the file, for example application/pdf or image/png. Defaults to the type Square’s spec shows, image/jpeg. |
content_type is the file’s MIME type and defaults to image/jpeg. Sent as multipart: request is a plain form field and the file is in image_file.
Output
| Name | Type | Required | Description |
|---|---|---|---|
attachment | object | null | No | — |
errors | object[] | null | No | — |
attachment full type
attachment full type
{
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
delete
invoices.delete
Deletes the specified invoice. When an invoice is deleted, the associated order status changes to CANCELED. If you pass version, it must be the current one; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.invoices.delete({ invoice_id: '<invoice id>' });
| Name | Type | Required | Description |
|---|---|---|---|
invoice_id | string | Yes | The ID of the invoice to delete. |
version | number | No | The version of the invoice to delete. If you do not know the version, you can call GetInvoice or ListInvoices. |
version is optional; if you pass it, it must be the current one (read it with invoices.get, since every committed change, including adding or removing an attachment, increments it).
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
deleteAttachment
invoices.deleteAttachment
Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only from invoices in the DRAFT, SCHEDULED, UNPAID, or PARTIALLY_PAID state. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.invoices.deleteAttachment({ invoice_id: '<invoice id>', attachment_id: '<attachment id>' });
| Name | Type | Required | Description |
|---|---|---|---|
invoice_id | string | Yes | The ID of the invoice to delete the attachment from. |
attachment_id | string | Yes | The ID of the attachment to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
invoices.get
Retrieves an invoice by invoice ID.
Risk: read
await corsair.square.api.invoices.get({ invoice_id: '<invoice id>' });
| Name | Type | Required | Description |
|---|---|---|---|
invoice_id | string | Yes | The ID of the invoice to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | null | No | — |
errors | object[] | null | No | — |
invoice full type
invoice full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
list
invoices.list
Returns a list of invoices for a given location. The response is paginated. If truncated, the response includes a cursor that you use in a subsequent request to retrieve the next set of invoices.
Risk: read
await corsair.square.api.invoices.list({ location_id: '<location id>', cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the location for which to list invoices. |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. |
limit | number | No | The maximum number of invoices to return (200 is the maximum limit). If not provided, the server uses a default limit of 100 invoices. |
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
invoices full type
invoices full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
publish
invoices.publish
Publishes the specified draft invoice. Sends the invoice to the customer and may charge the card on file; cancel with invoices.cancel. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Moves money. Pass the same idempotency_key to retry safely.
Risk: destructive
await corsair.square.api.invoices.publish({ invoice_id: '<invoice id>', version: 0 });
| Name | Type | Required | Description |
|---|---|---|---|
version | number | Yes | The version of the invoice to publish. This must match the current version of the invoice; otherwise, the request is rejected. |
idempotency_key | string | null | No | A unique string that identifies the PublishInvoice request. |
invoice_id | string | Yes | The ID of the invoice to publish. |
version from invoices.get; every committed change, including adding or removing an attachment, increments it. Square then emails the customer and/or charges the card on file, depending on the invoice.
Output
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | null | No | — |
errors | object[] | null | No | — |
invoice full type
invoice full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
search
invoices.search
Searches for invoices from a location specified in the filter. You can optionally specify customers in the filter for whom to retrieve invoices.
Risk: read
await corsair.square.api.invoices.search({
query: {
filter: {
location_ids: ['<location ids>'],
},
},
cursor: '<cursor>',
limit: 1,
});
| Name | Type | Required | Description |
|---|---|---|---|
query | object | Yes | Describes the query criteria for searching invoices. |
limit | number | No | The maximum number of invoices to return (200 is the maximum limit). If not provided, the server uses a default limit of 100 invoices. |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. |
query full type
query full type
{
filter: {
location_ids: string[],
customer_ids?: string[] | null
},
sort?: {
field: INVOICE_SORT_DATE,
order?: DESC | ASC
}
}
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
invoices full type
invoices full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
update
invoices.update
Updates an invoice. This endpoint supports sparse updates, so you only need to specify the fields you want to change along with the required version field. Some restrictions apply to updating invoices. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Pass the same idempotency_key to retry safely.
Risk: destructive
await corsair.square.api.invoices.update({
invoice_id: '<invoice id>',
invoice: { version: 1, title: 'November services' },
});
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | Yes | The invoice fields to add, change, or clear. Fields can be cleared using null values or the remove field (for individual payment requests or reminders). |
idempotency_key | string | null | No | A unique string that identifies the UpdateInvoice request. |
fields_to_clear | string[] | null | No | The list of fields to clear. Although this field is currently supported, we recommend using null values or the remove field when possible. For examples, see Update an Invoice. |
invoice_id | string | Yes | The ID of the invoice to update. |
version from invoices.get; every committed change, including adding or removing an attachment, increments it. To remove a payment request or a reminder, send its uid with remove: true (Square’s Update an Invoice guide).
invoice full type
invoice full type
{
id?: string,
version?: number,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string,
family_name?: string,
email_address?: string,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
phone_number?: string,
company_name?: string,
tax_ids?: {
eu_vat?: string
}
},
payment_requests?: {
uid?: string | null,
request_method?: EMAIL | CHARGE_CARD_ON_FILE | SHARE_MANUALLY | CHARGE_BANK_ON_FILE | SMS | SMS_CHARGE_CARD_ON_FILE | SMS_CHARGE_BANK_ON_FILE,
request_type?: BALANCE | DEPOSIT | INSTALLMENT,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: NONE | CARD_ON_FILE | BANK_ON_FILE,
card_id?: string | null,
reminders?: {
uid?: string,
relative_scheduled_days?: number | null,
message?: string | null,
status?: PENDING | NOT_APPLICABLE | SENT,
sent_at?: string,
remove?: boolean
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_completed_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
remove?: boolean
}[] | null,
delivery_method?: EMAIL | SHARE_MANUALLY | SMS,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string,
next_payment_amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status?: DRAFT | UNPAID | SCHEDULED | PARTIALLY_PAID | PAID | PARTIALLY_REFUNDED | REFUNDED | CANCELED | FAILED | PAYMENT_PENDING,
timezone?: string,
created_at?: string,
updated_at?: string,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
},
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: ABOVE_LINE_ITEMS | BELOW_LINE_ITEMS
}[] | null,
subscription_id?: string,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string,
filename?: string,
description?: string,
filesize?: number,
hash?: string,
mime_type?: string,
uploaded_at?: string
}[],
creator_team_member_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
invoice | object | null | No | — |
errors | object[] | null | No | — |
invoice full type
invoice full type
{
id?: string | null,
version?: number | null,
location_id?: string | null,
order_id?: string | null,
primary_recipient?: {
customer_id?: string | null,
given_name?: string | null,
family_name?: string | null,
email_address?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
phone_number?: string | null,
company_name?: string | null,
tax_ids?: {
eu_vat?: string | null
} | null
} | null,
payment_requests?: {
uid?: string | null,
request_method?: string | null,
request_type?: string | null,
due_date?: string | null,
fixed_amount_requested_money?: {
amount?: number | null,
currency?: string | null
} | null,
percentage_requested?: string | null,
tipping_enabled?: boolean | null,
automatic_payment_source?: string | null,
card_id?: string | null,
reminders?: {
uid?: string | null,
relative_scheduled_days?: number | null,
message?: string | null,
status?: string | null,
sent_at?: string | null
}[] | null,
computed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_completed_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
rounding_adjustment_included_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
delivery_method?: string | null,
invoice_number?: string | null,
title?: string | null,
description?: string | null,
scheduled_at?: string | null,
public_url?: string | null,
next_payment_amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
timezone?: string | null,
created_at?: string | null,
updated_at?: string | null,
accepted_payment_methods?: {
card?: boolean | null,
square_gift_card?: boolean | null,
bank_account?: boolean | null,
buy_now_pay_later?: boolean | null,
cash_app_pay?: boolean | null
} | null,
custom_fields?: {
label?: string | null,
value?: string | null,
placement?: string | null
}[] | null,
subscription_id?: string | null,
sale_or_service_date?: string | null,
payment_conditions?: string | null,
store_payment_method_enabled?: boolean | null,
attachments?: {
id?: string | null,
filename?: string | null,
description?: string | null,
filesize?: number | null,
hash?: string | null,
mime_type?: string | null,
uploaded_at?: string | null
}[] | null,
creator_team_member_id?: string | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Locations
create
locations.create
Creates a location. Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Locations can’t be deleted; deactivate with locations.update.
Risk: write
await corsair.square.api.locations.create({});
| Name | Type | Required | Description |
|---|---|---|---|
location | object | No | The initial values of the location being created. The name field is required and must be unique within a seller account. |
locations.update.
location full type
location full type
{
id?: string,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
timezone?: string | null,
capabilities?: (CREDIT_CARD_PROCESSING | AUTOMATIC_TRANSFERS | UNLINKED_REFUNDS)[],
status?: ACTIVE | INACTIVE,
created_at?: string,
merchant_id?: string,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
language_code?: string | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS,
phone_number?: string | null,
business_name?: string | null,
type?: PHYSICAL | MOBILE,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: SUN | MON | TUE | WED | THU | FRI | SAT,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
},
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
},
logo_url?: string,
pos_background_url?: string,
mcc?: string | null,
full_format_logo_url?: string,
tax_ids?: {
eu_vat?: string,
fr_siret?: string,
fr_naf?: string,
es_nif?: string,
jp_qii?: string
},
custom_receipt_text?: string | null,
return_policy?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
location | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location full type
location full type
{
id?: string | null,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
timezone?: string | null,
capabilities?: string[] | null,
status?: string | null,
created_at?: string | null,
merchant_id?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
phone_number?: string | null,
business_name?: string | null,
type?: string | null,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: string | null,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
} | null,
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
} | null,
logo_url?: string | null,
pos_background_url?: string | null,
mcc?: string | null,
full_format_logo_url?: string | null,
tax_ids?: {
eu_vat?: string | null,
fr_siret?: string | null,
fr_naf?: string | null,
es_nif?: string | null,
jp_qii?: string | null
} | null,
custom_receipt_text?: string | null,
return_policy?: string | null
} | null
get
locations.get
Retrieves details of a single location. Specify “main” as the location ID to retrieve details of the main location.
Risk: read
await corsair.square.api.locations.get({ location_id: '<location id>' });
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | The ID of the location to retrieve. Specify the string “main” to return the main location. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
location | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location full type
location full type
{
id?: string | null,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
timezone?: string | null,
capabilities?: string[] | null,
status?: string | null,
created_at?: string | null,
merchant_id?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
phone_number?: string | null,
business_name?: string | null,
type?: string | null,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: string | null,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
} | null,
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
} | null,
logo_url?: string | null,
pos_background_url?: string | null,
mcc?: string | null,
full_format_logo_url?: string | null,
tax_ids?: {
eu_vat?: string | null,
fr_siret?: string | null,
fr_naf?: string | null,
es_nif?: string | null,
jp_qii?: string | null
} | null,
custom_receipt_text?: string | null,
return_policy?: string | null
} | null
list
locations.list
Provides details about all of the seller’s locations, including those with an inactive status. Locations are listed alphabetically by name.
Risk: read
await corsair.square.api.locations.list({});
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
locations | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
locations full type
locations full type
{
id?: string | null,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
timezone?: string | null,
capabilities?: string[] | null,
status?: string | null,
created_at?: string | null,
merchant_id?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
phone_number?: string | null,
business_name?: string | null,
type?: string | null,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: string | null,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
} | null,
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
} | null,
logo_url?: string | null,
pos_background_url?: string | null,
mcc?: string | null,
full_format_logo_url?: string | null,
tax_ids?: {
eu_vat?: string | null,
fr_siret?: string | null,
fr_naf?: string | null,
es_nif?: string | null,
jp_qii?: string | null
} | null,
custom_receipt_text?: string | null,
return_policy?: string | null
}[] | null
update
locations.update
Updates a location.
Risk: write
await corsair.square.api.locations.update({ location_id: '<location id>' });
| Name | Type | Required | Description |
|---|---|---|---|
location | object | No | The Location object with only the fields to update. |
location_id | string | Yes | The ID of the location to update. |
location full type
location full type
{
id?: string,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
timezone?: string | null,
capabilities?: (CREDIT_CARD_PROCESSING | AUTOMATIC_TRANSFERS | UNLINKED_REFUNDS)[],
status?: ACTIVE | INACTIVE,
created_at?: string,
merchant_id?: string,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
language_code?: string | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS,
phone_number?: string | null,
business_name?: string | null,
type?: PHYSICAL | MOBILE,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: SUN | MON | TUE | WED | THU | FRI | SAT,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
},
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
},
logo_url?: string,
pos_background_url?: string,
mcc?: string | null,
full_format_logo_url?: string,
tax_ids?: {
eu_vat?: string,
fr_siret?: string,
fr_naf?: string,
es_nif?: string,
jp_qii?: string
},
custom_receipt_text?: string | null,
return_policy?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
location | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
location full type
location full type
{
id?: string | null,
name?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
timezone?: string | null,
capabilities?: string[] | null,
status?: string | null,
created_at?: string | null,
merchant_id?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
phone_number?: string | null,
business_name?: string | null,
type?: string | null,
website_url?: string | null,
business_hours?: {
periods?: {
day_of_week?: string | null,
start_local_time?: string | null,
end_local_time?: string | null
}[] | null
} | null,
business_email?: string | null,
description?: string | null,
twitter_username?: string | null,
instagram_username?: string | null,
facebook_url?: string | null,
coordinates?: {
latitude?: number | null,
longitude?: number | null
} | null,
logo_url?: string | null,
pos_background_url?: string | null,
mcc?: string | null,
full_format_logo_url?: string | null,
tax_ids?: {
eu_vat?: string | null,
fr_siret?: string | null,
fr_naf?: string | null,
es_nif?: string | null,
jp_qii?: string | null
} | null,
custom_receipt_text?: string | null,
return_policy?: string | null
} | null
Merchants
get
merchants.get
Retrieves the Merchant object for the given merchant_id.
Risk: read
await corsair.square.api.merchants.get({ merchant_id: '<merchant id>' });
| Name | Type | Required | Description |
|---|---|---|---|
merchant_id | string | Yes | The ID of the merchant to retrieve. If the string “me” is supplied as the ID, then retrieve the merchant that is currently accessible to this call. |
me as merchant_id for the merchant that owns the access token.
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
merchant | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant full type
merchant full type
{
id?: string | null,
business_name?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
status?: string | null,
main_location_id?: string | null,
created_at?: string | null
} | null
list
merchants.list
Provides details about the merchant associated with a given access token.
Risk: read
await corsair.square.api.merchants.list({ cursor: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | number | No | The cursor generated by the previous response. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
merchant | object[] | null | No | — |
cursor | number | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
merchant full type
merchant full type
{
id?: string | null,
business_name?: string | null,
country?: string | null,
language_code?: string | null,
currency?: string | null,
status?: string | null,
main_location_id?: string | null,
created_at?: string | null
}[] | null
Oauth
getTokenStatus
oauth.getTokenStatus
Returns information about an OAuth access token or an application’s personal access token.
Risk: read
await corsair.square.api.oauth.getTokenStatus({});
| Name | Type | Required | Description |
|---|---|---|---|
scopes | string[] | null | No | — |
expires_at | string | null | No | — |
client_id | string | null | No | — |
merchant_id | string | null | No | — |
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Orders
calculate
orders.calculate
Enables applications to preview order pricing without creating an order. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Beta in Square’s API; it may change.
Risk: read
await corsair.square.api.orders.calculate({
order: { location_id: '<location id>' },
});
| Name | Type | Required | Description |
|---|---|---|---|
order | object | Yes | The order to be calculated. Expects the entire order, not a sparse update. |
proposed_rewards | object[] | null | No | Identifies one or more loyalty reward tiers to apply during the order calculation. |
order full type
order full type
{
id?: string,
location_id: string,
reference_id?: string | null,
source?: {
name?: string | null
},
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_sales_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pricing_blocklists?: {
blocked_discounts?: {
uid?: string | null,
discount_uid?: string | null,
discount_catalog_object_id?: string | null
}[] | null,
blocked_taxes?: {
uid?: string | null,
tax_uid?: string | null,
tax_catalog_object_id?: string | null
}[] | null,
blocked_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
service_charge_catalog_object_id?: string | null
}[] | null
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER,
auto_applied?: boolean
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER,
reward_ids?: string[],
pricing_rule_id?: string
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
metadata?: Record<string, string> | null,
type?: AUTO_GRATUITY | CUSTOM,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER
}[] | null,
fulfillments?: {
uid?: string | null,
type?: PICKUP | SHIPMENT | DELIVERY | IN_STORE,
state?: PROPOSED | RESERVED | PREPARED | COMPLETED | CANCELED | FAILED,
line_item_application?: ALL | ENTRY_LIST,
entries?: {
uid?: string | null,
line_item_uid: string,
quantity: string,
metadata?: Record<string, string> | null
}[],
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: SCHEDULED | ASAP,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string,
accepted_at?: string,
rejected_at?: string,
ready_at?: string,
expired_at?: string,
picked_up_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: {
curbside_details?: string | null,
buyer_arrived_at?: string | null
}
},
shipment_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string,
in_progress_at?: string,
packaged_at?: string,
expected_shipped_at?: string | null,
shipped_at?: string,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string,
failure_reason?: string | null
},
delivery_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
schedule_type?: SCHEDULED | ASAP,
placed_at?: string,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string,
rejected_at?: string,
ready_at?: string,
delivered_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
},
in_store_details?: {
note?: string | null,
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
placed_at?: string | null,
completed_at?: string,
in_progress_at?: string,
prepared_at?: string,
canceled_at?: string
}
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
return_modifiers?: {
uid?: string | null,
source_modifier_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
quantity?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_return_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER,
type?: AUTO_GRATUITY | CUSTOM
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[],
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
tenders?: {
id?: string,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
customer_id?: string | null,
type: CARD | CASH | THIRD_PARTY_CARD | SQUARE_GIFT_CARD | NO_SALE | BANK_ACCOUNT | WALLET | BUY_NOW_PAY_LATER | SQUARE_ACCOUNT | OTHER,
card_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED,
card?: {
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
},
entry_method?: SWIPED | KEYED | EMV | ON_FILE | CONTACTLESS
},
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
bank_account_details?: {
status?: PENDING | COMPLETED | FAILED
},
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: OTHER_BRAND | AFTERPAY,
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
square_account_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[],
refunds?: {
id: string,
location_id: string,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string,
reason: string,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status: PENDING | APPROVED | REJECTED | FAILED,
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null
}[],
metadata?: Record<string, string> | null,
created_at?: string,
updated_at?: string,
closed_at?: string,
state?: OPEN | COMPLETED | CANCELED | DRAFT,
version?: number,
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
},
rewards?: {
id: string,
reward_tier_id: string
}[],
net_amount_due_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
proposed_rewards full type
proposed_rewards full type
{
id: string,
reward_tier_id: string
}[] | null
| Name | Type | Required | Description |
|---|---|---|---|
order | object | null | No | — |
errors | object[] | null | No | — |
order full type
order full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
create
orders.create
Creates a new order that can include information about products for purchase and settings to apply to the purchase. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.orders.create({
idempotency_key: '<a unique key>',
order: {
location_id: '<location id>',
line_items: [{
name: 'Coffee',
quantity: '1',
base_price_money: { amount: 350, currency: 'USD' },
}],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
order | object | No | The order to create. If this field is set, the only other top-level field that can be set is the idempotency_key. |
idempotency_key | string | No | A value you specify that uniquely identifies this order among orders you have created. |
order full type
order full type
{
id?: string,
location_id: string,
reference_id?: string | null,
source?: {
name?: string | null
},
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_sales_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pricing_blocklists?: {
blocked_discounts?: {
uid?: string | null,
discount_uid?: string | null,
discount_catalog_object_id?: string | null
}[] | null,
blocked_taxes?: {
uid?: string | null,
tax_uid?: string | null,
tax_catalog_object_id?: string | null
}[] | null,
blocked_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
service_charge_catalog_object_id?: string | null
}[] | null
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER,
auto_applied?: boolean
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER,
reward_ids?: string[],
pricing_rule_id?: string
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
metadata?: Record<string, string> | null,
type?: AUTO_GRATUITY | CUSTOM,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER
}[] | null,
fulfillments?: {
uid?: string | null,
type?: PICKUP | SHIPMENT | DELIVERY | IN_STORE,
state?: PROPOSED | RESERVED | PREPARED | COMPLETED | CANCELED | FAILED,
line_item_application?: ALL | ENTRY_LIST,
entries?: {
uid?: string | null,
line_item_uid: string,
quantity: string,
metadata?: Record<string, string> | null
}[],
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: SCHEDULED | ASAP,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string,
accepted_at?: string,
rejected_at?: string,
ready_at?: string,
expired_at?: string,
picked_up_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: {
curbside_details?: string | null,
buyer_arrived_at?: string | null
}
},
shipment_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string,
in_progress_at?: string,
packaged_at?: string,
expected_shipped_at?: string | null,
shipped_at?: string,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string,
failure_reason?: string | null
},
delivery_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
schedule_type?: SCHEDULED | ASAP,
placed_at?: string,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string,
rejected_at?: string,
ready_at?: string,
delivered_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
},
in_store_details?: {
note?: string | null,
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
placed_at?: string | null,
completed_at?: string,
in_progress_at?: string,
prepared_at?: string,
canceled_at?: string
}
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
return_modifiers?: {
uid?: string | null,
source_modifier_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
quantity?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_return_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER,
type?: AUTO_GRATUITY | CUSTOM
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[],
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
tenders?: {
id?: string,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
customer_id?: string | null,
type: CARD | CASH | THIRD_PARTY_CARD | SQUARE_GIFT_CARD | NO_SALE | BANK_ACCOUNT | WALLET | BUY_NOW_PAY_LATER | SQUARE_ACCOUNT | OTHER,
card_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED,
card?: {
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
},
entry_method?: SWIPED | KEYED | EMV | ON_FILE | CONTACTLESS
},
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
bank_account_details?: {
status?: PENDING | COMPLETED | FAILED
},
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: OTHER_BRAND | AFTERPAY,
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
square_account_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[],
refunds?: {
id: string,
location_id: string,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string,
reason: string,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status: PENDING | APPROVED | REJECTED | FAILED,
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null
}[],
metadata?: Record<string, string> | null,
created_at?: string,
updated_at?: string,
closed_at?: string,
state?: OPEN | COMPLETED | CANCELED | DRAFT,
version?: number,
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
},
rewards?: {
id: string,
reward_tier_id: string
}[],
net_amount_due_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
| Name | Type | Required | Description |
|---|---|---|---|
order | object | null | No | — |
errors | object[] | null | No | — |
order full type
order full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
orders.get
Retrieves an Order by ID.
Risk: read
await corsair.square.api.orders.get({ order_id: '<order id>' });
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Yes | The ID of the order to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
order | object | null | No | — |
errors | object[] | null | No | — |
order full type
order full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
pay
orders.pay
Pay for an order using one or more approved payments or settle an order with a total of 0. Approved payments for the same order_id that are not listed in payment_ids are canceled. Moves money. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: destructive
await corsair.square.api.orders.pay({
order_id: '<order id>',
idempotency_key: '<a unique key; reuse it to retry>',
payment_ids: ['<payment id>'],
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A value you specify that uniquely identifies this request among requests you have sent. |
order_version | number | null | No | The version of the order being paid. If not supplied, the latest version will be paid. |
payment_ids | string[] | null | No | The IDs of the payments to collect. The payment total must match the order total. |
order_id | string | Yes | The ID of the order being paid. |
payment_ids must equal the order total. Approved payments that reference this order_id but are not listed in payment_ids are canceled.
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
order | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
order full type
order full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
search
orders.search
Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs).
Risk: read
await corsair.square.api.orders.search({
location_ids: ['<location id>'],
cursor: '<cursor>',
limit: 1,
});
| Name | Type | Required | Description |
|---|---|---|---|
location_ids | string[] | No | The location IDs for the orders to query. All locations must belong to the same merchant. |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. |
query | object | No | Query conditions used to filter or sort the results. Note that when retrieving additional pages using a cursor, you must use the original query. |
limit | number | No | The maximum number of results to be returned in a single page. |
return_entries | boolean | No | A Boolean that controls the format of the search results. If true, SearchOrders returns OrderEntry objects. If false, SearchOrders returns complete order objects. |
query full type
query full type
{
filter?: {
state_filter?: {
states: (OPEN | COMPLETED | CANCELED | DRAFT)[]
},
date_time_filter?: {
created_at?: {
start_at?: string | null,
end_at?: string | null
},
updated_at?: {
start_at?: string | null,
end_at?: string | null
},
closed_at?: {
start_at?: string | null,
end_at?: string | null
}
},
fulfillment_filter?: {
fulfillment_types?: (PICKUP | SHIPMENT | DELIVERY | IN_STORE)[] | null,
fulfillment_states?: (PROPOSED | RESERVED | PREPARED | COMPLETED | CANCELED | FAILED)[] | null
},
source_filter?: {
source_names?: string[] | null
},
customer_filter?: {
customer_ids?: string[] | null
}
},
sort?: {
sort_field: CREATED_AT | UPDATED_AT | CLOSED_AT,
sort_order?: DESC | ASC
}
}
| Name | Type | Required | Description |
|---|---|---|---|
order_entries | object[] | null | No | — |
orders | object[] | null | No | — |
cursor | string | null | No | — |
errors | object[] | null | No | — |
order_entries full type
order_entries full type
{
order_id?: string | null,
version?: number | null,
location_id?: string | null
}[] | null
orders full type
orders full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
update
orders.update
Updates an open order by adding, replacing, or deleting fields. Orders with a COMPLETED or CANCELED state cannot be updated. Send only the fields to change, plus the order’s current version. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change.
Risk: write
await corsair.square.api.orders.update({
order_id: '<order id>',
order: {
version: 1,
line_items: [{ uid: '<line item uid>', note: 'Extra hot' }],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
order | object | No | The sparse order containing only the fields to update and the version to which the update is being applied. |
fields_to_clear | string[] | null | No | The dot notation paths fields to clear. For example, line_items[uid].note. For more information, see Deleting fields. |
idempotency_key | string | null | No | A value you specify that uniquely identifies this update request. |
order_id | string | Yes | The ID of the order to update. |
order full type
order full type
{
id?: string,
location_id?: string,
reference_id?: string | null,
source?: {
name?: string | null
},
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any>,
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_sales_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pricing_blocklists?: {
blocked_discounts?: {
uid?: string | null,
discount_uid?: string | null,
discount_catalog_object_id?: string | null
}[] | null,
blocked_taxes?: {
uid?: string | null,
tax_uid?: string | null,
tax_catalog_object_id?: string | null
}[] | null,
blocked_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
service_charge_catalog_object_id?: string | null
}[] | null
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER,
auto_applied?: boolean
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER,
reward_ids?: string[],
pricing_rule_id?: string
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
metadata?: Record<string, string> | null,
type?: AUTO_GRATUITY | CUSTOM,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER
}[] | null,
fulfillments?: {
uid?: string | null,
type?: PICKUP | SHIPMENT | DELIVERY | IN_STORE,
state?: PROPOSED | RESERVED | PREPARED | COMPLETED | CANCELED | FAILED,
line_item_application?: ALL | ENTRY_LIST,
entries?: {
uid?: string | null,
line_item_uid?: string,
quantity?: string,
metadata?: Record<string, string> | null
}[],
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: SCHEDULED | ASAP,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string,
accepted_at?: string,
rejected_at?: string,
ready_at?: string,
expired_at?: string,
picked_up_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: {
curbside_details?: string | null,
buyer_arrived_at?: string | null
}
},
shipment_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string,
in_progress_at?: string,
packaged_at?: string,
expected_shipped_at?: string | null,
shipped_at?: string,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string,
failure_reason?: string | null
},
delivery_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
schedule_type?: SCHEDULED | ASAP,
placed_at?: string,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string,
rejected_at?: string,
ready_at?: string,
delivered_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
},
in_store_details?: {
note?: string | null,
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
placed_at?: string | null,
completed_at?: string,
in_progress_at?: string,
prepared_at?: string,
canceled_at?: string
}
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any>,
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
return_modifiers?: {
uid?: string | null,
source_modifier_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
quantity?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_return_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER,
type?: AUTO_GRATUITY | CUSTOM
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[],
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
tenders?: {
id?: string,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
customer_id?: string | null,
type?: CARD | CASH | THIRD_PARTY_CARD | SQUARE_GIFT_CARD | NO_SALE | BANK_ACCOUNT | WALLET | BUY_NOW_PAY_LATER | SQUARE_ACCOUNT | OTHER,
card_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED,
card?: {
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
},
entry_method?: SWIPED | KEYED | EMV | ON_FILE | CONTACTLESS
},
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
bank_account_details?: {
status?: PENDING | COMPLETED | FAILED
},
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: OTHER_BRAND | AFTERPAY,
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
square_account_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
additional_recipients?: {
location_id?: string,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[],
refunds?: {
id?: string,
location_id?: string,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string,
reason?: string,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status?: PENDING | APPROVED | REJECTED | FAILED,
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
additional_recipients?: {
location_id?: string,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null
}[],
metadata?: Record<string, string> | null,
created_at?: string,
updated_at?: string,
closed_at?: string,
state?: OPEN | COMPLETED | CANCELED | DRAFT,
version?: number,
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
},
rewards?: {
id?: string,
reward_tier_id?: string
}[],
net_amount_due_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
| Name | Type | Required | Description |
|---|---|---|---|
order | object | null | No | — |
errors | object[] | null | No | — |
order full type
order full type
{
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
Payment Links
create
paymentLinks.create
Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.paymentLinks.create({
idempotency_key: '<a unique key>',
quick_pay: {
name: 'Coffee',
price_money: { amount: 450, currency: 'USD' },
location_id: '<location id>',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | No | A unique string that identifies this CreatePaymentLinkRequest request. |
description | string | No | A description of the payment link. You provide this optional description that is useful in your application context. It is not used anywhere. |
quick_pay | object | No | Describes an ad hoc item and price for which to generate a quick pay checkout link. For more information, see Quick Pay Checkout. |
order | object | No | Describes the Order for which to create a checkout link. For more information, see Square Order Checkout. |
checkout_options | object | No | Describes optional fields to add to the resulting checkout page. For more information, see Optional Checkout Configurations. |
pre_populated_data | object | No | Describes fields to prepopulate in the resulting checkout page. For more information, see Prepopulate the shipping address. |
payment_note | string | No | A note for the payment. After processing the payment, Square adds this note to the resulting Payment. |
quick_pay full type
quick_pay full type
{
name: string,
price_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
location_id: string
}
order full type
order full type
{
id?: string,
location_id: string,
reference_id?: string | null,
source?: {
name?: string | null
},
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_sales_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
pricing_blocklists?: {
blocked_discounts?: {
uid?: string | null,
discount_uid?: string | null,
discount_catalog_object_id?: string | null
}[] | null,
blocked_taxes?: {
uid?: string | null,
tax_uid?: string | null,
tax_catalog_object_id?: string | null
}[] | null,
blocked_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
service_charge_catalog_object_id?: string | null
}[] | null
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER,
auto_applied?: boolean
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
metadata?: Record<string, string> | null,
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER,
reward_ids?: string[],
pricing_rule_id?: string
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
metadata?: Record<string, string> | null,
type?: AUTO_GRATUITY | CUSTOM,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER
}[] | null,
fulfillments?: {
uid?: string | null,
type?: PICKUP | SHIPMENT | DELIVERY | IN_STORE,
state?: PROPOSED | RESERVED | PREPARED | COMPLETED | CANCELED | FAILED,
line_item_application?: ALL | ENTRY_LIST,
entries?: {
uid?: string | null,
line_item_uid: string,
quantity: string,
metadata?: Record<string, string> | null
}[],
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: SCHEDULED | ASAP,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string,
accepted_at?: string,
rejected_at?: string,
ready_at?: string,
expired_at?: string,
picked_up_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: {
curbside_details?: string | null,
buyer_arrived_at?: string | null
}
},
shipment_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string,
in_progress_at?: string,
packaged_at?: string,
expected_shipped_at?: string | null,
shipped_at?: string,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string,
failure_reason?: string | null
},
delivery_details?: {
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
schedule_type?: SCHEDULED | ASAP,
placed_at?: string,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string,
rejected_at?: string,
ready_at?: string,
delivered_at?: string,
canceled_at?: string,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
},
in_store_details?: {
note?: string | null,
recipient?: {
customer_id?: string | null,
display_name?: string | null,
email_address?: string | null,
phone_number?: string | null,
address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
placed_at?: string | null,
completed_at?: string,
in_progress_at?: string,
prepared_at?: string,
canceled_at?: string
}
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity: string,
quantity_unit?: {
measurement_unit?: {
custom_unit?: {
name: string,
abbreviation: string
},
area_unit?: IMPERIAL_ACRE | IMPERIAL_SQUARE_INCH | IMPERIAL_SQUARE_FOOT | IMPERIAL_SQUARE_YARD | IMPERIAL_SQUARE_MILE | METRIC_SQUARE_CENTIMETER | METRIC_SQUARE_METER | METRIC_SQUARE_KILOMETER,
length_unit?: IMPERIAL_INCH | IMPERIAL_FOOT | IMPERIAL_YARD | IMPERIAL_MILE | METRIC_MILLIMETER | METRIC_CENTIMETER | METRIC_METER | METRIC_KILOMETER,
volume_unit?: GENERIC_FLUID_OUNCE | GENERIC_SHOT | GENERIC_CUP | GENERIC_PINT | GENERIC_QUART | GENERIC_GALLON | IMPERIAL_CUBIC_INCH | IMPERIAL_CUBIC_FOOT | IMPERIAL_CUBIC_YARD | METRIC_MILLILITER | METRIC_LITER,
weight_unit?: IMPERIAL_WEIGHT_OUNCE | IMPERIAL_POUND | IMPERIAL_STONE | METRIC_MILLIGRAM | METRIC_GRAM | METRIC_KILOGRAM,
generic_unit?: UNIT,
time_unit?: GENERIC_MILLISECOND | GENERIC_SECOND | GENERIC_MINUTE | GENERIC_HOUR | GENERIC_DAY,
type?: TYPE_CUSTOM | TYPE_AREA | TYPE_LENGTH | TYPE_VOLUME | TYPE_WEIGHT | TYPE_GENERIC
},
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
},
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: ITEM | CUSTOM_AMOUNT | GIFT_CARD,
return_modifiers?: {
uid?: string | null,
source_modifier_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
quantity?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
variation_total_price_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
gross_return_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_service_charges?: {
uid?: string | null,
service_charge_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
calculation_phase?: SUBTOTAL_PHASE | TOTAL_PHASE | APPORTIONED_PERCENTAGE_PHASE | APPORTIONED_AMOUNT_PHASE,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid: string,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
auto_applied?: boolean
}[] | null,
treatment_type?: LINE_ITEM_TREATMENT | APPORTIONED_TREATMENT,
scope?: OTHER_SERVICE_CHARGE_SCOPE | LINE_ITEM | ORDER,
type?: AUTO_GRATUITY | CUSTOM
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_TAX | ADDITIVE | INCLUSIVE,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_TAX_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: UNKNOWN_DISCOUNT | FIXED_PERCENTAGE | FIXED_AMOUNT | VARIABLE_PERCENTAGE | VARIABLE_AMOUNT,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
scope?: OTHER_DISCOUNT_SCOPE | LINE_ITEM | ORDER
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
}[],
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
tenders?: {
id?: string,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
customer_id?: string | null,
type: CARD | CASH | THIRD_PARTY_CARD | SQUARE_GIFT_CARD | NO_SALE | BANK_ACCOUNT | WALLET | BUY_NOW_PAY_LATER | SQUARE_ACCOUNT | OTHER,
card_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED,
card?: {
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
},
entry_method?: SWIPED | KEYED | EMV | ON_FILE | CONTACTLESS
},
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
bank_account_details?: {
status?: PENDING | COMPLETED | FAILED
},
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: OTHER_BRAND | AFTERPAY,
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
square_account_details?: {
status?: AUTHORIZED | CAPTURED | VOIDED | FAILED
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[],
refunds?: {
id: string,
location_id: string,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string,
reason: string,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status: PENDING | APPROVED | REJECTED | FAILED,
processing_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
additional_recipients?: {
location_id: string,
description?: string | null,
amount_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
receivable_id?: string | null
}[] | null
}[],
metadata?: Record<string, string> | null,
created_at?: string,
updated_at?: string,
closed_at?: string,
state?: OPEN | COMPLETED | CANCELED | DRAFT,
version?: number,
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tax_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_discount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_service_charge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
},
rewards?: {
id: string,
reward_tier_id: string
}[],
net_amount_due_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
checkout_options full type
checkout_options full type
{
allow_tipping?: boolean | null,
custom_fields?: {
title: string
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
},
app_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
shipping_fee?: {
name?: string | null,
charge: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
}
pre_populated_data full type
pre_populated_data full type
{
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment_link | object | null | No | — |
related_resources | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment_link full type
payment_link full type
{
id?: string | null,
version?: number | null,
description?: string | null,
order_id?: string | null,
checkout_options?: {
allow_tipping?: boolean | null,
custom_fields?: {
title?: string | null
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
shipping_fee?: {
name?: string | null,
charge?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
} | null,
pre_populated_data?: {
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null
} | null,
url?: string | null,
long_url?: string | null,
created_at?: string | null,
updated_at?: string | null,
payment_note?: string | null
} | null
related_resources full type
related_resources full type
{
orders?: {
id?: string | null,
location_id?: string | null,
reference_id?: string | null,
source?: {
name?: string | null
} | null,
customer_id?: string | null,
line_items?: {
uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
metadata?: Record<string, string> | null,
modifiers?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
quantity?: string | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
parent_modifier_uid?: string | null
}[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_sales_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_blocklists?: {
blocked_discounts?: Record<string, any>[] | null,
blocked_taxes?: Record<string, any>[] | null,
blocked_service_charges?: Record<string, any>[] | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
taxes?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
metadata?: Record<string, string> | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null,
auto_applied?: boolean | null
}[] | null,
discounts?: {
uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
metadata?: Record<string, string> | null,
scope?: string | null,
reward_ids?: string[] | null,
pricing_rule_id?: string | null
}[] | null,
service_charges?: {
uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
metadata?: Record<string, string> | null,
type?: string | null,
treatment_type?: string | null,
scope?: string | null
}[] | null,
fulfillments?: {
uid?: string | null,
type?: string | null,
state?: string | null,
line_item_application?: string | null,
entries?: {
uid?: string | null,
line_item_uid?: string | null,
quantity?: string | null,
metadata?: Record<string, string> | null
}[] | null,
metadata?: Record<string, string> | null,
pickup_details?: {
recipient?: Record<string, any> | null,
expires_at?: string | null,
auto_complete_duration?: string | null,
schedule_type?: string | null,
pickup_at?: string | null,
pickup_window_duration?: string | null,
prep_time_duration?: string | null,
note?: string | null,
placed_at?: string | null,
accepted_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
expired_at?: string | null,
picked_up_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
is_curbside_pickup?: boolean | null,
curbside_pickup_details?: Record<string, any> | null
} | null,
shipment_details?: {
recipient?: Record<string, any> | null,
carrier?: string | null,
shipping_note?: string | null,
shipping_type?: string | null,
tracking_number?: string | null,
tracking_url?: string | null,
placed_at?: string | null,
in_progress_at?: string | null,
packaged_at?: string | null,
expected_shipped_at?: string | null,
shipped_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
failed_at?: string | null,
failure_reason?: string | null
} | null,
delivery_details?: {
recipient?: Record<string, any> | null,
schedule_type?: string | null,
placed_at?: string | null,
deliver_at?: string | null,
prep_time_duration?: string | null,
delivery_window_duration?: string | null,
note?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
rejected_at?: string | null,
ready_at?: string | null,
delivered_at?: string | null,
canceled_at?: string | null,
cancel_reason?: string | null,
courier_pickup_at?: string | null,
courier_pickup_window_duration?: string | null,
is_no_contact_delivery?: boolean | null,
dropoff_notes?: string | null,
courier_provider_name?: string | null,
courier_support_phone_number?: string | null,
square_delivery_id?: string | null,
external_delivery_id?: string | null,
managed_delivery?: boolean | null
} | null,
in_store_details?: {
note?: string | null,
recipient?: Record<string, any> | null,
placed_at?: string | null,
completed_at?: string | null,
in_progress_at?: string | null,
prepared_at?: string | null,
canceled_at?: string | null
} | null
}[] | null,
returns?: {
uid?: string | null,
source_order_id?: string | null,
return_line_items?: {
uid?: string | null,
source_line_item_uid?: string | null,
name?: string | null,
quantity?: string | null,
quantity_unit?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null,
catalog_object_id?: string | null,
catalog_version?: number | null
} | null,
note?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
variation_name?: string | null,
item_type?: string | null,
return_modifiers?: Record<string, any>[] | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
applied_discounts?: {
uid?: string | null,
discount_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
base_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
variation_total_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
gross_return_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_service_charges?: {
uid?: string | null,
service_charge_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
return_service_charges?: {
uid?: string | null,
source_service_charge_uid?: string | null,
name?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
calculation_phase?: string | null,
taxable?: boolean | null,
applied_taxes?: {
uid?: string | null,
tax_uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
auto_applied?: boolean | null
}[] | null,
treatment_type?: string | null,
scope?: string | null,
type?: string | null
}[] | null,
return_taxes?: {
uid?: string | null,
source_tax_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_discounts?: {
uid?: string | null,
source_discount_uid?: string | null,
catalog_object_id?: string | null,
catalog_version?: number | null,
name?: string | null,
type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
scope?: string | null
}[] | null,
return_tips?: {
uid?: string | null,
applied_money?: {
amount?: number | null,
currency?: string | null
} | null,
source_tender_uid?: string | null,
source_tender_id?: string | null
}[] | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null
}[] | null,
return_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
net_amounts?: {
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
rounding_adjustment?: {
uid?: string | null,
name?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
tenders?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
created_at?: string | null,
note?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_id?: string | null,
type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null
} | null,
cash_details?: {
buyer_tendered_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
status?: string | null
} | null,
buy_now_pay_later_details?: {
buy_now_pay_later_brand?: string | null,
status?: string | null
} | null,
square_account_details?: {
status?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null,
payment_id?: string | null
}[] | null,
refunds?: {
id?: string | null,
location_id?: string | null,
transaction_id?: string | null,
tender_id?: string | null,
created_at?: string | null,
reason?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
processing_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
additional_recipients?: {
location_id?: string | null,
description?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
receivable_id?: string | null
}[] | null
}[] | null,
metadata?: Record<string, string> | null,
created_at?: string | null,
updated_at?: string | null,
closed_at?: string | null,
state?: string | null,
version?: number | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tax_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_discount_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_service_charge_money?: {
amount?: number | null,
currency?: string | null
} | null,
ticket_name?: string | null,
pricing_options?: {
auto_apply_discounts?: boolean | null,
auto_apply_taxes?: boolean | null
} | null,
rewards?: {
id?: string | null,
reward_tier_id?: string | null
}[] | null,
net_amount_due_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
subscription_plans?: {
type?: string | null,
id?: string | null,
updated_at?: string | null,
version?: number | null,
is_deleted?: boolean | null,
custom_attribute_values?: Record<string, {
name?: string | null,
string_value?: string | null,
custom_attribute_definition_id?: string | null,
type?: string | null,
number_value?: string | null,
boolean_value?: boolean | null,
selection_uid_values?: string[] | null,
key?: string | null
}> | null,
catalog_v1_ids?: {
catalog_v1_id?: string | null,
location_id?: string | null
}[] | null,
present_at_all_locations?: boolean | null,
present_at_location_ids?: string[] | null,
absent_at_location_ids?: string[] | null,
item_data?: {
name?: string | null,
description?: string | null,
abbreviation?: string | null,
label_color?: string | null,
is_taxable?: boolean | null,
category_id?: string | null,
buyer_facing_name?: string | null,
tax_ids?: string[] | null,
modifier_list_info?: {
modifier_list_id?: string | null,
modifier_overrides?: Record<string, any>[] | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
enabled?: boolean | null,
ordinal?: number | null,
allow_quantities?: string | null,
is_conversational?: string | null,
hidden_from_customer_override?: string | null
}[] | null,
variations?: Record<string, any>[] | null,
product_type?: string | null,
skip_modifier_screen?: boolean | null,
item_options?: {
item_option_id?: string | null
}[] | null,
ecom_uri?: string | null,
ecom_image_uris?: string[] | null,
image_ids?: string[] | null,
sort_name?: string | null,
categories?: {
id?: string | null,
ordinal?: number | null
}[] | null,
description_html?: string | null,
description_plaintext?: string | null,
kitchen_name?: string | null,
channels?: string[] | null,
is_archived?: boolean | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
food_and_beverage_details?: {
calorie_count?: number | null,
dietary_preferences?: Record<string, any>[] | null,
ingredients?: Record<string, any>[] | null
} | null,
reporting_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_alcoholic?: boolean | null
} | null,
category_data?: {
name?: string | null,
image_ids?: string[] | null,
category_type?: string | null,
parent_category?: {
id?: string | null,
ordinal?: number | null
} | null,
is_top_level?: boolean | null,
channels?: string[] | null,
availability_period_ids?: string[] | null,
online_visibility?: boolean | null,
root_category?: string | null,
ecom_seo_data?: {
page_title?: string | null,
page_description?: string | null,
permalink?: string | null
} | null,
path_to_root?: {
category_id?: string | null,
category_name?: string | null
}[] | null
} | null,
item_variation_data?: {
item_id?: string | null,
name?: string | null,
sku?: string | null,
upc?: string | null,
ordinal?: number | null,
pricing_type?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
pricing_type?: string | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
sold_out?: boolean | null,
sold_out_valid_until?: string | null
}[] | null,
track_inventory?: boolean | null,
inventory_alert_type?: string | null,
inventory_alert_threshold?: number | null,
user_data?: string | null,
service_duration?: number | null,
available_for_booking?: boolean | null,
item_option_values?: {
item_option_id?: string | null,
item_option_value_id?: string | null
}[] | null,
measurement_unit_id?: string | null,
sellable?: boolean | null,
stockable?: boolean | null,
image_ids?: string[] | null,
team_member_ids?: string[] | null,
stockable_conversion?: {
stockable_item_variation_id?: string | null,
stockable_quantity?: string | null,
nonstockable_quantity?: string | null
} | null,
kitchen_name?: string | null,
vendor_information?: {
vendor_id?: string | null,
vendor_code?: string | null,
unit_cost_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null
} | null,
tax_data?: {
name?: string | null,
calculation_phase?: string | null,
inclusion_type?: string | null,
percentage?: string | null,
applies_to_custom_amounts?: boolean | null,
enabled?: boolean | null,
applies_to_product_set_id?: string | null
} | null,
discount_data?: {
name?: string | null,
discount_type?: string | null,
percentage?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
pin_required?: boolean | null,
label_color?: string | null,
modify_tax_basis?: string | null,
maximum_amount_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
modifier_list_data?: {
name?: string | null,
ordinal?: number | null,
selection_type?: string | null,
modifiers?: Record<string, any>[] | null,
image_ids?: string[] | null,
allow_quantities?: boolean | null,
is_conversational?: boolean | null,
modifier_type?: string | null,
max_length?: number | null,
text_required?: boolean | null,
internal_name?: string | null,
min_selected_modifiers?: number | null,
max_selected_modifiers?: number | null,
hidden_from_customer?: boolean | null
} | null,
modifier_data?: {
name?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
on_by_default?: boolean | null,
ordinal?: number | null,
modifier_list_id?: string | null,
location_overrides?: {
location_id?: string | null,
price_money?: {
amount?: number | null,
currency?: string | null
} | null,
sold_out?: boolean | null
}[] | null,
kitchen_name?: string | null,
image_id?: string | null,
hidden_online?: boolean | null,
child_modifier_list_ids?: string[] | null
} | null,
time_period_data?: {
event?: string | null
} | null,
product_set_data?: {
name?: string | null,
product_ids_any?: string[] | null,
product_ids_all?: string[] | null,
quantity_exact?: number | null,
quantity_min?: number | null,
quantity_max?: number | null,
all_products?: boolean | null
} | null,
pricing_rule_data?: {
name?: string | null,
time_period_ids?: string[] | null,
discount_id?: string | null,
match_products_id?: string | null,
apply_products_id?: string | null,
exclude_products_id?: string | null,
valid_from_date?: string | null,
valid_from_local_time?: string | null,
valid_until_date?: string | null,
valid_until_local_time?: string | null,
exclude_strategy?: string | null,
minimum_order_subtotal_money?: {
amount?: number | null,
currency?: string | null
} | null,
customer_group_ids_any?: string[] | null
} | null,
image_data?: {
name?: string | null,
url?: string | null,
caption?: string | null,
photo_studio_order_id?: string | null
} | null,
measurement_unit_data?: {
measurement_unit?: {
custom_unit?: Record<string, any> | null,
area_unit?: string | null,
length_unit?: string | null,
volume_unit?: string | null,
weight_unit?: string | null,
generic_unit?: string | null,
time_unit?: string | null,
type?: string | null
} | null,
precision?: number | null
} | null,
subscription_plan_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_variations?: Record<string, any>[] | null,
eligible_item_ids?: string[] | null,
eligible_category_ids?: string[] | null,
all_items?: boolean | null
} | null,
item_option_data?: {
name?: string | null,
display_name?: string | null,
description?: string | null,
show_colors?: boolean | null,
values?: Record<string, any>[] | null
} | null,
item_option_value_data?: {
item_option_id?: string | null,
name?: string | null,
description?: string | null,
color?: string | null,
ordinal?: number | null
} | null,
custom_attribute_definition_data?: {
type?: string | null,
name?: string | null,
description?: string | null,
source_application?: {
product?: string | null,
application_id?: string | null,
name?: string | null
} | null,
allowed_object_types?: string[] | null,
seller_visibility?: string | null,
app_visibility?: string | null,
string_config?: {
enforce_uniqueness?: boolean | null
} | null,
number_config?: {
precision?: number | null
} | null,
selection_config?: {
max_allowed_selections?: number | null,
allowed_selections?: Record<string, any>[] | null
} | null,
custom_attribute_usage_count?: number | null,
key?: string | null
} | null,
quick_amounts_settings_data?: {
option?: string | null,
eligible_for_auto_amounts?: boolean | null,
amounts?: {
type?: string | null,
amount?: {
amount?: number | null,
currency?: string | null
} | null,
score?: number | null,
ordinal?: number | null
}[] | null
} | null,
subscription_plan_variation_data?: {
name?: string | null,
phases?: {
uid?: string | null,
cadence?: string | null,
periods?: number | null,
recurring_price_money?: {
amount?: number | null,
currency?: string | null
} | null,
ordinal?: number | null,
pricing?: Record<string, any> | null
}[] | null,
subscription_plan_id?: string | null,
monthly_billing_anchor_date?: number | null,
can_prorate?: boolean | null,
successor_plan_variation_id?: string | null
} | null,
availability_period_data?: {
start_local_time?: string | null,
end_local_time?: string | null,
day_of_week?: string | null
} | null
}[] | null
} | null
delete
paymentLinks.delete
Deletes a payment link. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.paymentLinks.delete({ id: '<id>' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the payment link to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
id | string | null | No | — |
cancelled_order_id | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
paymentLinks.get
Retrieves a payment link.
Risk: read
await corsair.square.api.paymentLinks.get({ id: '<id>' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of link to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment_link | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment_link full type
payment_link full type
{
id?: string | null,
version?: number | null,
description?: string | null,
order_id?: string | null,
checkout_options?: {
allow_tipping?: boolean | null,
custom_fields?: {
title?: string | null
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
shipping_fee?: {
name?: string | null,
charge?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
} | null,
pre_populated_data?: {
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null
} | null,
url?: string | null,
long_url?: string | null,
created_at?: string | null,
updated_at?: string | null,
payment_note?: string | null
} | null
list
paymentLinks.list
Lists all payment links.
Risk: read
await corsair.square.api.paymentLinks.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. |
limit | number | No | A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment_links | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment_links full type
payment_links full type
{
id?: string | null,
version?: number | null,
description?: string | null,
order_id?: string | null,
checkout_options?: {
allow_tipping?: boolean | null,
custom_fields?: {
title?: string | null
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
shipping_fee?: {
name?: string | null,
charge?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
} | null,
pre_populated_data?: {
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null
} | null,
url?: string | null,
long_url?: string | null,
created_at?: string | null,
updated_at?: string | null,
payment_note?: string | null
}[] | null
update
paymentLinks.update
Updates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data.
Risk: write
await corsair.square.api.paymentLinks.update({
id: '<id>',
payment_link: { version: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
payment_link | object | Yes | The payment_link object describing the updates to apply. For more information, see Update a payment link. |
id | string | Yes | The ID of the payment link to update. |
payment_link full type
payment_link full type
{
id?: string,
version: number,
description?: string | null,
order_id?: string,
checkout_options?: {
allow_tipping?: boolean | null,
custom_fields?: {
title: string
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
},
app_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
shipping_fee?: {
name?: string | null,
charge: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
},
pre_populated_data?: {
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
},
url?: string,
long_url?: string,
created_at?: string,
updated_at?: string,
payment_note?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment_link | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment_link full type
payment_link full type
{
id?: string | null,
version?: number | null,
description?: string | null,
order_id?: string | null,
checkout_options?: {
allow_tipping?: boolean | null,
custom_fields?: {
title?: string | null
}[] | null,
subscription_plan_id?: string | null,
redirect_url?: string | null,
merchant_support_email?: string | null,
ask_for_shipping_address?: boolean | null,
accepted_payment_methods?: {
apple_pay?: boolean | null,
google_pay?: boolean | null,
cash_app_pay?: boolean | null,
afterpay_clearpay?: boolean | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
shipping_fee?: {
name?: string | null,
charge?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
enable_coupon?: boolean | null,
enable_loyalty?: boolean | null
} | null,
pre_populated_data?: {
buyer_email?: string | null,
buyer_phone_number?: string | null,
buyer_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null
} | null,
url?: string | null,
long_url?: string | null,
created_at?: string | null,
updated_at?: string | null,
payment_note?: string | null
} | null
Payments
cancel
payments.cancel
Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED status. Moves money. Square takes no idempotency_key here; payments.get shows whether the payment is already canceled before you repeat the call. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.payments.cancel({ payment_id: '<payment id>' });
| Name | Type | Required | Description |
|---|---|---|---|
payment_id | string | Yes | The ID of the payment to cancel. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment full type
payment full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
} | null
cancelByIdempotencyKey
payments.cancelByIdempotencyKey
Voids a payment by the idempotency_key of the payments.create call that made it; use when that call’s response was lost. Moves money. Its idempotency_key names the payment to cancel; it does not make this call repeatable. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.payments.cancelByIdempotencyKey({ idempotency_key: '<key of the payments.create to void>' });
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | The idempotency_key identifying the payment to be canceled. |
idempotency_key here names the payment to cancel (the key of the payments.create call that made it). It does not make this call repeatable.
Output
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
complete
payments.complete
Completes (captures) a payment. By default, payments are set to complete immediately after they are created. Moves money. Square takes no idempotency_key here; payments.get shows whether the payment is already completed before you repeat the call.
Risk: destructive
await corsair.square.api.payments.complete({ payment_id: '<payment id>' });
| Name | Type | Required | Description |
|---|---|---|---|
version_token | string | null | No | Used for optimistic concurrency. This opaque token identifies the current Payment version that the caller expects. |
payment_id | string | Yes | The unique ID identifying the payment to be completed. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment full type
payment full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
} | null
create
payments.create
Creates a payment using the provided source. customer_id is required if source_id is a card on file created with the Cards API. Moves money. Pass the same idempotency_key to retry safely.
Risk: destructive
await corsair.square.api.payments.create({
source_id: 'cnon:card-nonce-ok',
idempotency_key: '<a unique key; reuse it to retry this charge>',
amount_money: { amount: 1000, currency: 'USD' },
location_id: '<location id>',
});
| Name | Type | Required | Description |
|---|---|---|---|
source_id | string | Yes | The ID for the source of funds for this payment. |
idempotency_key | string | Yes | A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. |
amount_money | object | No | The amount of money to accept for this payment, not including tip_money. |
tip_money | object | No | The amount designated as a tip, in addition to amount_money. |
app_fee_money | object | No | The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller. |
app_fee_allocations | Record<string, any>[] | No | Details pertaining to recipients of the application fee. The sum of the amounts in the app_fee_allocations must equal the app_fee_money amount, if present. |
delay_duration | string | No | The duration of time after the payment’s creation when Square automatically either completes or cancels the payment depending on the delay_action field value. |
delay_action | string | No | The action to be applied to the payment when the delay_duration has elapsed. The action must be CANCEL or COMPLETE. For more information, see Time Threshold. |
autocomplete | boolean | No | If set to true, this payment will be completed when possible. |
order_id | string | No | Associates a previously created order with this payment. |
customer_id | string | No | The Customer ID of the customer associated with the payment. |
location_id | string | No | The location ID to associate with the payment. If not specified, the main location is used. |
team_member_id | string | No | An optional TeamMember ID to associate with this payment. |
reference_id | string | No | A user-defined ID to associate with the payment. |
verification_token | string | No | An identifying token generated by payments.verifyBuyer(). |
accept_partial_authorization | boolean | No | If set to true and charging a Square Gift Card, a payment might be returned with amount_money equal to less than what was requested. |
buyer_email_address | string | No | The buyer’s email address. |
buyer_phone_number | string | No | The buyer’s phone number. Must follow the following format: 1. A leading + symbol (followed by a country code) 2. |
billing_address | object | No | The buyer’s billing address. |
shipping_address | object | No | The buyer’s shipping address. |
note | string | No | An optional note to be entered by the developer when creating a payment. |
statement_description_identifier | string | No | Optional additional payment information to include on the customer’s card statement as part of the statement description. |
cash_details | object | No | Additional details required when recording a cash payment (source_id is CASH). |
external_details | object | No | Additional details required when recording an external payment (source_id is EXTERNAL). |
customer_details | object | No | Details about the customer making the payment. |
offline_payment_details | object | No | An optional field for specifying the offline payment details. This is intended for internal 1st-party callers only. |
source_id from Square’s Web Payments SDK, a card on file (cards.create), or in the sandbox the test nonce cnon:card-nonce-ok. The payment completes immediately unless you set autocomplete: false; finish a delayed one with payments.complete.
amount_money full type
amount_money full type
{
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
tip_money full type
tip_money full type
{
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
app_fee_money full type
app_fee_money full type
{
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
billing_address full type
billing_address full type
{
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
shipping_address full type
shipping_address full type
{
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
}
cash_details full type
cash_details full type
{
buyer_supplied_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
external_details full type
external_details full type
{
type: string,
source: string,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
customer_details full type
customer_details full type
{
customer_initiated?: boolean | null,
seller_keyed_in?: boolean | null
}
offline_payment_details full type
offline_payment_details full type
{
client_created_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment full type
payment full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
} | null
get
payments.get
Retrieves details for a specific payment.
Risk: read
await corsair.square.api.payments.get({ payment_id: '<payment id>' });
| Name | Type | Required | Description |
|---|---|---|---|
payment_id | string | Yes | A unique ID for the desired payment. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment full type
payment full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
} | null
list
payments.list
Retrieves a list of payments taken by the account making the request.
Risk: read
await corsair.square.api.payments.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
begin_time | string | No | Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment. Inclusive. |
end_time | string | No | Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment. |
sort_order | string | No | The order in which results are listed by ListPaymentsRequest.sort_field: - ASC - Oldest to newest. - DESC - Newest to oldest (default). |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. |
location_id | string | No | Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller. |
total | number | No | The exact amount in the total_money for a payment. |
last_4 | string | No | The last four digits of a payment card. |
card_brand | string | No | The brand of the payment card (for example, VISA). |
limit | number | No | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. |
is_offline_payment | boolean | No | Whether the payment was taken offline or not. |
offline_begin_time | string | No | Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the `offline_payment_details. |
offline_end_time | string | No | Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the `offline_payment_details. |
updated_at_begin_time | string | No | Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the updated_at field for each Payment. |
updated_at_end_time | string | No | Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the updated_at field for each Payment. |
sort_field | CREATED_AT | OFFLINE_CREATED_AT | UPDATED_AT | No | The field used to sort results by. The default is CREATED_AT. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payments | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payments full type
payments full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
}[] | null
refund
payments.refund
Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. customer_id is required if destination_id is a card on file created with the Cards API, and is only allowed when unlinked=true. Moves money. Pass the same idempotency_key to retry safely. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.payments.refund({
idempotency_key: '<a unique key; reuse it to retry this refund>',
payment_id: '<payment id>',
amount_money: { amount: 500, currency: 'USD' },
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | Yes | A unique string that identifies this RefundPayment request. The key can be any valid string but must be unique for every RefundPayment request. |
amount_money | object | Yes | The amount of money to refund. |
app_fee_money | object | No | The amount of money the developer contributes to help cover the refunded amount. |
app_fee_allocations | Record<string, any>[] | null | No | Details pertaining to contributors to the refund of the application fee. The sum of the amounts in the app_fee_allocations must equal the app_fee_money amount, if present. |
payment_id | string | null | No | The unique ID of the payment being refunded. Required when unlinked=false, otherwise must not be set. |
destination_id | string | null | No | The ID indicating where funds will be refunded to. Required for unlinked refunds. For more information, see Process an Unlinked Refund. |
unlinked | boolean | null | No | Indicates that the refund is not linked to a Square payment. If set to true, destination_id and location_id must be supplied while payment_id must not be provided. |
location_id | string | null | No | The location ID associated with the unlinked refund. Required for requests specifying unlinked=true. Otherwise, if included when unlinked=false, will throw an error. |
customer_id | string | null | No | The Customer ID of the customer associated with the refund. This is required if the destination_id refers to a card on file created using the Cards API. |
reason | string | null | No | A description of the reason for the refund. |
payment_version_token | string | null | No | Used for optimistic concurrency. This opaque token identifies the current Payment version that the caller expects. |
team_member_id | string | null | No | An optional TeamMember ID to associate with this refund. |
cash_details | object | No | Additional details required when recording an unlinked cash refund (destination_id is CASH). |
external_details | object | No | Additional details required when recording an unlinked external refund (destination_id is EXTERNAL). |
payment_id and amount_money. A refund cannot be reversed; use a new idempotency_key for a second refund, and the same one to retry the first.
amount_money full type
amount_money full type
{
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
app_fee_money full type
app_fee_money full type
{
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
cash_details full type
cash_details full type
{
seller_supplied_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}
external_details full type
external_details full type
{
type: string,
source: string,
source_id?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
refund | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
refund full type
refund full type
{
id?: string | null,
status?: string | null,
location_id?: string | null,
unlinked?: boolean | null,
destination_type?: string | null,
destination_details?: {
card_details?: {
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
auth_result_code?: string | null
} | null,
cash_details?: {
seller_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null
} | null
} | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
payment_id?: string | null,
order_id?: string | null,
reason?: string | null,
created_at?: string | null,
updated_at?: string | null,
team_member_id?: string | null,
terminal_refund_id?: string | null
} | null
update
payments.update
Updates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint. Moves money. Pass the same idempotency_key to retry safely.
Risk: destructive
await corsair.square.api.payments.update({ payment_id: '<payment id>', idempotency_key: '<idempotency key>' });
| Name | Type | Required | Description |
|---|---|---|---|
payment | object | No | The updated Payment object. |
idempotency_key | string | Yes | A unique string that identifies this UpdatePayment request. Keys can be any valid string but must be unique for every UpdatePayment request. |
payment_id | string | Yes | The ID of the payment to update. |
payment full type
payment full type
{
id?: string,
created_at?: string,
updated_at?: string,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
tip_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
total_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
app_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
}[],
refunded_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
status?: string,
delay_duration?: string,
delay_action?: string | null,
delayed_until?: string,
source_type?: string,
card_details?: {
status?: string,
card?: {
id?: string,
card_brand?: OTHER_BRAND | VISA | MASTERCARD | AMERICAN_EXPRESS | DISCOVER | DISCOVER_DINERS | JCB | CHINA_UNIONPAY | SQUARE_GIFT_CARD | SQUARE_CAPITAL_CARD | INTERAC | EFTPOS | FELICA | EBT | QUICPAY | ID | TRANSPORTATION_IC | CARNET,
last_4?: string,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
fingerprint?: string,
customer_id?: string | null,
merchant_id?: string,
reference_id?: string | null,
enabled?: boolean,
card_type?: UNKNOWN_CARD_TYPE | CREDIT | DEBIT,
prepaid_type?: UNKNOWN_PREPAID_TYPE | NOT_PREPAID | PREPAID,
bin?: string,
created_at?: string,
disabled_at?: string,
version?: number,
card_co_brand?: UNKNOWN | AFTERPAY | CLEARPAY,
issuer_alert?: ISSUER_ALERT_CARD_CLOSED,
issuer_alert_at?: string,
hsa_fsa?: boolean
},
entry_method?: string,
cvv_status?: string,
avs_status?: string,
auth_result_code?: string,
application_identifier?: string,
application_name?: string,
application_cryptogram?: string,
verification_method?: string,
verification_results?: string,
statement_description?: string,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
},
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
},
refund_requires_card_presence?: boolean,
errors?: {
category: API_ERROR | AUTHENTICATION_ERROR | INVALID_REQUEST_ERROR | RATE_LIMIT_ERROR | PAYMENT_METHOD_ERROR | REFUND_ERROR | MERCHANT_SUBSCRIPTION_ERROR | EXTERNAL_VENDOR_ERROR,
code: INTERNAL_SERVER_ERROR | UNAUTHORIZED | ACCESS_TOKEN_EXPIRED | ACCESS_TOKEN_REVOKED | CLIENT_DISABLED | FORBIDDEN | INSUFFICIENT_SCOPES | APPLICATION_DISABLED | V1_APPLICATION | V1_ACCESS_TOKEN | CARD_PROCESSING_NOT_ENABLED | MERCHANT_SUBSCRIPTION_NOT_FOUND | BAD_REQUEST | MISSING_REQUIRED_PARAMETER | INCORRECT_TYPE | INVALID_TIME | INVALID_TIME_RANGE | INVALID_VALUE | INVALID_CURSOR | UNKNOWN_QUERY_PARAMETER | CONFLICTING_PARAMETERS | EXPECTED_JSON_BODY | INVALID_SORT_ORDER | VALUE_REGEX_MISMATCH | VALUE_TOO_SHORT | VALUE_TOO_LONG | VALUE_TOO_LOW | VALUE_TOO_HIGH | VALUE_EMPTY | ARRAY_LENGTH_TOO_LONG | ARRAY_LENGTH_TOO_SHORT | ARRAY_EMPTY | EXPECTED_BOOLEAN | EXPECTED_INTEGER | EXPECTED_FLOAT | EXPECTED_STRING | EXPECTED_OBJECT | EXPECTED_ARRAY | EXPECTED_MAP | EXPECTED_BASE64_ENCODED_BYTE_ARRAY | INVALID_ARRAY_VALUE | INVALID_ENUM_VALUE | INVALID_CONTENT_TYPE | INVALID_FORM_VALUE | CUSTOMER_NOT_FOUND | ONE_INSTRUMENT_EXPECTED | NO_FIELDS_SET | TOO_MANY_MAP_ENTRIES | MAP_KEY_LENGTH_TOO_SHORT | MAP_KEY_LENGTH_TOO_LONG | CUSTOMER_MISSING_NAME | CUSTOMER_MISSING_EMAIL | INVALID_PAUSE_LENGTH | INVALID_DATE | UNSUPPORTED_COUNTRY | UNSUPPORTED_CURRENCY | APPLE_TTP_PIN_TOKEN | CARD_EXPIRED | INVALID_EXPIRATION | INVALID_EXPIRATION_YEAR | INVALID_EXPIRATION_DATE | UNSUPPORTED_CARD_BRAND | UNSUPPORTED_ENTRY_METHOD | INVALID_ENCRYPTED_CARD | INVALID_CARD | PAYMENT_AMOUNT_MISMATCH | GENERIC_DECLINE | CVV_FAILURE | ADDRESS_VERIFICATION_FAILURE | INVALID_ACCOUNT | CURRENCY_MISMATCH | INSUFFICIENT_FUNDS | INSUFFICIENT_PERMISSIONS | CARDHOLDER_INSUFFICIENT_PERMISSIONS | INVALID_LOCATION | TRANSACTION_LIMIT | VOICE_FAILURE | PAN_FAILURE | EXPIRATION_FAILURE | CARD_NOT_SUPPORTED | READER_DECLINED | INVALID_PIN | MISSING_PIN | MISSING_ACCOUNT_TYPE | INVALID_POSTAL_CODE | INVALID_FEES | MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED | PAYMENT_LIMIT_EXCEEDED | GIFT_CARD_AVAILABLE_AMOUNT | ACCOUNT_UNUSABLE | BUYER_REFUSED_PAYMENT | DELAYED_TRANSACTION_EXPIRED | DELAYED_TRANSACTION_CANCELED | DELAYED_TRANSACTION_CAPTURED | DELAYED_TRANSACTION_FAILED | CARD_TOKEN_EXPIRED | CARD_TOKEN_USED | AMOUNT_TOO_HIGH | AMOUNT_TOO_LOW | UNSUPPORTED_INSTRUMENT_TYPE | REFUND_AMOUNT_INVALID | REFUND_ALREADY_PENDING | PAYMENT_NOT_REFUNDABLE | PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE | REFUND_ERROR_PAYMENT_NEEDS_COMPLETION | REFUND_DECLINED | INSUFFICIENT_PERMISSIONS_FOR_REFUND | INVALID_CARD_DATA | SOURCE_USED | SOURCE_EXPIRED | UNSUPPORTED_LOYALTY_REWARD_TIER | LOCATION_MISMATCH | ORDER_UNPAID_NOT_RETURNABLE | PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED | IDEMPOTENCY_KEY_REUSED | UNEXPECTED_VALUE | SANDBOX_NOT_SUPPORTED | INVALID_EMAIL_ADDRESS | INVALID_PHONE_NUMBER | CHECKOUT_EXPIRED | BAD_CERTIFICATE | INVALID_SQUARE_VERSION_FORMAT | API_VERSION_INCOMPATIBLE | CARD_PRESENCE_REQUIRED | UNSUPPORTED_SOURCE_TYPE | CARD_MISMATCH | PLAID_ERROR | PLAID_ERROR_ITEM_LOGIN_REQUIRED | PLAID_ERROR_RATE_LIMIT | PLAID_ERROR_INVALID_ACCESS_TOKEN | PLAID_ERROR_INVALID_ACCOUNT_ID | PLAID_ERROR_NO_ACCOUNTS | PLAID_ERROR_ITEM_NOT_FOUND | PLAID_ERROR_INSUFFICIENT_CREDENTIALS | PLAID_ERROR_ITEM_NOT_SUPPORTED | PLAID_ERROR_PRODUCT_NOT_READY | PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET | CARD_DECLINED | VERIFY_CVV_FAILURE | VERIFY_AVS_FAILURE | CARD_DECLINED_CALL_ISSUER | CARD_DECLINED_VERIFICATION_REQUIRED | BAD_EXPIRATION | CHIP_INSERTION_REQUIRED | ALLOWABLE_PIN_TRIES_EXCEEDED | RESERVATION_DECLINED | UNKNOWN_BODY_PARAMETER | CART_INELIGIBLE_FOR_EBT | NOT_FOUND | APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND | METHOD_NOT_ALLOWED | NOT_ACCEPTABLE | REQUEST_TIMEOUT | CONFLICT | GONE | REQUEST_ENTITY_TOO_LARGE | UNSUPPORTED_MEDIA_TYPE | UNPROCESSABLE_ENTITY | RATE_LIMITED | NOT_IMPLEMENTED | BAD_GATEWAY | SERVICE_UNAVAILABLE | TEMPORARY_ERROR | GATEWAY_TIMEOUT,
detail?: string,
field?: string
}[],
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
wallet_type?: string
},
cash_details?: {
buyer_supplied_money: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
},
change_back_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
},
errors?: {
category: API_ERROR | AUTHENTICATION_ERROR | INVALID_REQUEST_ERROR | RATE_LIMIT_ERROR | PAYMENT_METHOD_ERROR | REFUND_ERROR | MERCHANT_SUBSCRIPTION_ERROR | EXTERNAL_VENDOR_ERROR,
code: INTERNAL_SERVER_ERROR | UNAUTHORIZED | ACCESS_TOKEN_EXPIRED | ACCESS_TOKEN_REVOKED | CLIENT_DISABLED | FORBIDDEN | INSUFFICIENT_SCOPES | APPLICATION_DISABLED | V1_APPLICATION | V1_ACCESS_TOKEN | CARD_PROCESSING_NOT_ENABLED | MERCHANT_SUBSCRIPTION_NOT_FOUND | BAD_REQUEST | MISSING_REQUIRED_PARAMETER | INCORRECT_TYPE | INVALID_TIME | INVALID_TIME_RANGE | INVALID_VALUE | INVALID_CURSOR | UNKNOWN_QUERY_PARAMETER | CONFLICTING_PARAMETERS | EXPECTED_JSON_BODY | INVALID_SORT_ORDER | VALUE_REGEX_MISMATCH | VALUE_TOO_SHORT | VALUE_TOO_LONG | VALUE_TOO_LOW | VALUE_TOO_HIGH | VALUE_EMPTY | ARRAY_LENGTH_TOO_LONG | ARRAY_LENGTH_TOO_SHORT | ARRAY_EMPTY | EXPECTED_BOOLEAN | EXPECTED_INTEGER | EXPECTED_FLOAT | EXPECTED_STRING | EXPECTED_OBJECT | EXPECTED_ARRAY | EXPECTED_MAP | EXPECTED_BASE64_ENCODED_BYTE_ARRAY | INVALID_ARRAY_VALUE | INVALID_ENUM_VALUE | INVALID_CONTENT_TYPE | INVALID_FORM_VALUE | CUSTOMER_NOT_FOUND | ONE_INSTRUMENT_EXPECTED | NO_FIELDS_SET | TOO_MANY_MAP_ENTRIES | MAP_KEY_LENGTH_TOO_SHORT | MAP_KEY_LENGTH_TOO_LONG | CUSTOMER_MISSING_NAME | CUSTOMER_MISSING_EMAIL | INVALID_PAUSE_LENGTH | INVALID_DATE | UNSUPPORTED_COUNTRY | UNSUPPORTED_CURRENCY | APPLE_TTP_PIN_TOKEN | CARD_EXPIRED | INVALID_EXPIRATION | INVALID_EXPIRATION_YEAR | INVALID_EXPIRATION_DATE | UNSUPPORTED_CARD_BRAND | UNSUPPORTED_ENTRY_METHOD | INVALID_ENCRYPTED_CARD | INVALID_CARD | PAYMENT_AMOUNT_MISMATCH | GENERIC_DECLINE | CVV_FAILURE | ADDRESS_VERIFICATION_FAILURE | INVALID_ACCOUNT | CURRENCY_MISMATCH | INSUFFICIENT_FUNDS | INSUFFICIENT_PERMISSIONS | CARDHOLDER_INSUFFICIENT_PERMISSIONS | INVALID_LOCATION | TRANSACTION_LIMIT | VOICE_FAILURE | PAN_FAILURE | EXPIRATION_FAILURE | CARD_NOT_SUPPORTED | READER_DECLINED | INVALID_PIN | MISSING_PIN | MISSING_ACCOUNT_TYPE | INVALID_POSTAL_CODE | INVALID_FEES | MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED | PAYMENT_LIMIT_EXCEEDED | GIFT_CARD_AVAILABLE_AMOUNT | ACCOUNT_UNUSABLE | BUYER_REFUSED_PAYMENT | DELAYED_TRANSACTION_EXPIRED | DELAYED_TRANSACTION_CANCELED | DELAYED_TRANSACTION_CAPTURED | DELAYED_TRANSACTION_FAILED | CARD_TOKEN_EXPIRED | CARD_TOKEN_USED | AMOUNT_TOO_HIGH | AMOUNT_TOO_LOW | UNSUPPORTED_INSTRUMENT_TYPE | REFUND_AMOUNT_INVALID | REFUND_ALREADY_PENDING | PAYMENT_NOT_REFUNDABLE | PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE | REFUND_ERROR_PAYMENT_NEEDS_COMPLETION | REFUND_DECLINED | INSUFFICIENT_PERMISSIONS_FOR_REFUND | INVALID_CARD_DATA | SOURCE_USED | SOURCE_EXPIRED | UNSUPPORTED_LOYALTY_REWARD_TIER | LOCATION_MISMATCH | ORDER_UNPAID_NOT_RETURNABLE | PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED | IDEMPOTENCY_KEY_REUSED | UNEXPECTED_VALUE | SANDBOX_NOT_SUPPORTED | INVALID_EMAIL_ADDRESS | INVALID_PHONE_NUMBER | CHECKOUT_EXPIRED | BAD_CERTIFICATE | INVALID_SQUARE_VERSION_FORMAT | API_VERSION_INCOMPATIBLE | CARD_PRESENCE_REQUIRED | UNSUPPORTED_SOURCE_TYPE | CARD_MISMATCH | PLAID_ERROR | PLAID_ERROR_ITEM_LOGIN_REQUIRED | PLAID_ERROR_RATE_LIMIT | PLAID_ERROR_INVALID_ACCESS_TOKEN | PLAID_ERROR_INVALID_ACCOUNT_ID | PLAID_ERROR_NO_ACCOUNTS | PLAID_ERROR_ITEM_NOT_FOUND | PLAID_ERROR_INSUFFICIENT_CREDENTIALS | PLAID_ERROR_ITEM_NOT_SUPPORTED | PLAID_ERROR_PRODUCT_NOT_READY | PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET | CARD_DECLINED | VERIFY_CVV_FAILURE | VERIFY_AVS_FAILURE | CARD_DECLINED_CALL_ISSUER | CARD_DECLINED_VERIFICATION_REQUIRED | BAD_EXPIRATION | CHIP_INSERTION_REQUIRED | ALLOWABLE_PIN_TRIES_EXCEEDED | RESERVATION_DECLINED | UNKNOWN_BODY_PARAMETER | CART_INELIGIBLE_FOR_EBT | NOT_FOUND | APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND | METHOD_NOT_ALLOWED | NOT_ACCEPTABLE | REQUEST_TIMEOUT | CONFLICT | GONE | REQUEST_ENTITY_TOO_LARGE | UNSUPPORTED_MEDIA_TYPE | UNPROCESSABLE_ENTITY | RATE_LIMITED | NOT_IMPLEMENTED | BAD_GATEWAY | SERVICE_UNAVAILABLE | TEMPORARY_ERROR | GATEWAY_TIMEOUT,
detail?: string,
field?: string
}[] | null
},
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: UNKNOWN | FELICA_ID | FELICA_TRANSPORTATION | FELICA_QP
}
},
external_details?: {
type: string,
source: string,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: UNKNOWN_CURRENCY | AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHE | CHF | CHW | CLF | CLP | CNY | COP | COU | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LTL | LVL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MXV | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SLE | SOS | SRD | SSP | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | USN | USS | UYI | UYU | UZS | VEF | VND | VUV | WST | XAF | XAG | XAU | XBA | XBB | XBC | XBD | XCD | XDR | XOF | XPD | XPF | XPT | XTS | XXX | YER | ZAR | ZMK | ZMW | BTC | XUS
}
},
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string
},
lightning_details?: {
payment_url?: string | null
},
errors?: {
category: API_ERROR | AUTHENTICATION_ERROR | INVALID_REQUEST_ERROR | RATE_LIMIT_ERROR | PAYMENT_METHOD_ERROR | REFUND_ERROR | MERCHANT_SUBSCRIPTION_ERROR | EXTERNAL_VENDOR_ERROR,
code: INTERNAL_SERVER_ERROR | UNAUTHORIZED | ACCESS_TOKEN_EXPIRED | ACCESS_TOKEN_REVOKED | CLIENT_DISABLED | FORBIDDEN | INSUFFICIENT_SCOPES | APPLICATION_DISABLED | V1_APPLICATION | V1_ACCESS_TOKEN | CARD_PROCESSING_NOT_ENABLED | MERCHANT_SUBSCRIPTION_NOT_FOUND | BAD_REQUEST | MISSING_REQUIRED_PARAMETER | INCORRECT_TYPE | INVALID_TIME | INVALID_TIME_RANGE | INVALID_VALUE | INVALID_CURSOR | UNKNOWN_QUERY_PARAMETER | CONFLICTING_PARAMETERS | EXPECTED_JSON_BODY | INVALID_SORT_ORDER | VALUE_REGEX_MISMATCH | VALUE_TOO_SHORT | VALUE_TOO_LONG | VALUE_TOO_LOW | VALUE_TOO_HIGH | VALUE_EMPTY | ARRAY_LENGTH_TOO_LONG | ARRAY_LENGTH_TOO_SHORT | ARRAY_EMPTY | EXPECTED_BOOLEAN | EXPECTED_INTEGER | EXPECTED_FLOAT | EXPECTED_STRING | EXPECTED_OBJECT | EXPECTED_ARRAY | EXPECTED_MAP | EXPECTED_BASE64_ENCODED_BYTE_ARRAY | INVALID_ARRAY_VALUE | INVALID_ENUM_VALUE | INVALID_CONTENT_TYPE | INVALID_FORM_VALUE | CUSTOMER_NOT_FOUND | ONE_INSTRUMENT_EXPECTED | NO_FIELDS_SET | TOO_MANY_MAP_ENTRIES | MAP_KEY_LENGTH_TOO_SHORT | MAP_KEY_LENGTH_TOO_LONG | CUSTOMER_MISSING_NAME | CUSTOMER_MISSING_EMAIL | INVALID_PAUSE_LENGTH | INVALID_DATE | UNSUPPORTED_COUNTRY | UNSUPPORTED_CURRENCY | APPLE_TTP_PIN_TOKEN | CARD_EXPIRED | INVALID_EXPIRATION | INVALID_EXPIRATION_YEAR | INVALID_EXPIRATION_DATE | UNSUPPORTED_CARD_BRAND | UNSUPPORTED_ENTRY_METHOD | INVALID_ENCRYPTED_CARD | INVALID_CARD | PAYMENT_AMOUNT_MISMATCH | GENERIC_DECLINE | CVV_FAILURE | ADDRESS_VERIFICATION_FAILURE | INVALID_ACCOUNT | CURRENCY_MISMATCH | INSUFFICIENT_FUNDS | INSUFFICIENT_PERMISSIONS | CARDHOLDER_INSUFFICIENT_PERMISSIONS | INVALID_LOCATION | TRANSACTION_LIMIT | VOICE_FAILURE | PAN_FAILURE | EXPIRATION_FAILURE | CARD_NOT_SUPPORTED | READER_DECLINED | INVALID_PIN | MISSING_PIN | MISSING_ACCOUNT_TYPE | INVALID_POSTAL_CODE | INVALID_FEES | MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED | PAYMENT_LIMIT_EXCEEDED | GIFT_CARD_AVAILABLE_AMOUNT | ACCOUNT_UNUSABLE | BUYER_REFUSED_PAYMENT | DELAYED_TRANSACTION_EXPIRED | DELAYED_TRANSACTION_CANCELED | DELAYED_TRANSACTION_CAPTURED | DELAYED_TRANSACTION_FAILED | CARD_TOKEN_EXPIRED | CARD_TOKEN_USED | AMOUNT_TOO_HIGH | AMOUNT_TOO_LOW | UNSUPPORTED_INSTRUMENT_TYPE | REFUND_AMOUNT_INVALID | REFUND_ALREADY_PENDING | PAYMENT_NOT_REFUNDABLE | PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE | REFUND_ERROR_PAYMENT_NEEDS_COMPLETION | REFUND_DECLINED | INSUFFICIENT_PERMISSIONS_FOR_REFUND | INVALID_CARD_DATA | SOURCE_USED | SOURCE_EXPIRED | UNSUPPORTED_LOYALTY_REWARD_TIER | LOCATION_MISMATCH | ORDER_UNPAID_NOT_RETURNABLE | PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED | IDEMPOTENCY_KEY_REUSED | UNEXPECTED_VALUE | SANDBOX_NOT_SUPPORTED | INVALID_EMAIL_ADDRESS | INVALID_PHONE_NUMBER | CHECKOUT_EXPIRED | BAD_CERTIFICATE | INVALID_SQUARE_VERSION_FORMAT | API_VERSION_INCOMPATIBLE | CARD_PRESENCE_REQUIRED | UNSUPPORTED_SOURCE_TYPE | CARD_MISMATCH | PLAID_ERROR | PLAID_ERROR_ITEM_LOGIN_REQUIRED | PLAID_ERROR_RATE_LIMIT | PLAID_ERROR_INVALID_ACCESS_TOKEN | PLAID_ERROR_INVALID_ACCOUNT_ID | PLAID_ERROR_NO_ACCOUNTS | PLAID_ERROR_ITEM_NOT_FOUND | PLAID_ERROR_INSUFFICIENT_CREDENTIALS | PLAID_ERROR_ITEM_NOT_SUPPORTED | PLAID_ERROR_PRODUCT_NOT_READY | PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET | CARD_DECLINED | VERIFY_CVV_FAILURE | VERIFY_AVS_FAILURE | CARD_DECLINED_CALL_ISSUER | CARD_DECLINED_VERIFICATION_REQUIRED | BAD_EXPIRATION | CHIP_INSERTION_REQUIRED | ALLOWABLE_PIN_TRIES_EXCEEDED | RESERVATION_DECLINED | UNKNOWN_BODY_PARAMETER | CART_INELIGIBLE_FOR_EBT | NOT_FOUND | APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND | METHOD_NOT_ALLOWED | NOT_ACCEPTABLE | REQUEST_TIMEOUT | CONFLICT | GONE | REQUEST_ENTITY_TOO_LARGE | UNSUPPORTED_MEDIA_TYPE | UNPROCESSABLE_ENTITY | RATE_LIMITED | NOT_IMPLEMENTED | BAD_GATEWAY | SERVICE_UNAVAILABLE | TEMPORARY_ERROR | GATEWAY_TIMEOUT,
detail?: string,
field?: string
}[]
},
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
},
clearpay_details?: {
email_address?: string | null
},
errors?: {
category: API_ERROR | AUTHENTICATION_ERROR | INVALID_REQUEST_ERROR | RATE_LIMIT_ERROR | PAYMENT_METHOD_ERROR | REFUND_ERROR | MERCHANT_SUBSCRIPTION_ERROR | EXTERNAL_VENDOR_ERROR,
code: INTERNAL_SERVER_ERROR | UNAUTHORIZED | ACCESS_TOKEN_EXPIRED | ACCESS_TOKEN_REVOKED | CLIENT_DISABLED | FORBIDDEN | INSUFFICIENT_SCOPES | APPLICATION_DISABLED | V1_APPLICATION | V1_ACCESS_TOKEN | CARD_PROCESSING_NOT_ENABLED | MERCHANT_SUBSCRIPTION_NOT_FOUND | BAD_REQUEST | MISSING_REQUIRED_PARAMETER | INCORRECT_TYPE | INVALID_TIME | INVALID_TIME_RANGE | INVALID_VALUE | INVALID_CURSOR | UNKNOWN_QUERY_PARAMETER | CONFLICTING_PARAMETERS | EXPECTED_JSON_BODY | INVALID_SORT_ORDER | VALUE_REGEX_MISMATCH | VALUE_TOO_SHORT | VALUE_TOO_LONG | VALUE_TOO_LOW | VALUE_TOO_HIGH | VALUE_EMPTY | ARRAY_LENGTH_TOO_LONG | ARRAY_LENGTH_TOO_SHORT | ARRAY_EMPTY | EXPECTED_BOOLEAN | EXPECTED_INTEGER | EXPECTED_FLOAT | EXPECTED_STRING | EXPECTED_OBJECT | EXPECTED_ARRAY | EXPECTED_MAP | EXPECTED_BASE64_ENCODED_BYTE_ARRAY | INVALID_ARRAY_VALUE | INVALID_ENUM_VALUE | INVALID_CONTENT_TYPE | INVALID_FORM_VALUE | CUSTOMER_NOT_FOUND | ONE_INSTRUMENT_EXPECTED | NO_FIELDS_SET | TOO_MANY_MAP_ENTRIES | MAP_KEY_LENGTH_TOO_SHORT | MAP_KEY_LENGTH_TOO_LONG | CUSTOMER_MISSING_NAME | CUSTOMER_MISSING_EMAIL | INVALID_PAUSE_LENGTH | INVALID_DATE | UNSUPPORTED_COUNTRY | UNSUPPORTED_CURRENCY | APPLE_TTP_PIN_TOKEN | CARD_EXPIRED | INVALID_EXPIRATION | INVALID_EXPIRATION_YEAR | INVALID_EXPIRATION_DATE | UNSUPPORTED_CARD_BRAND | UNSUPPORTED_ENTRY_METHOD | INVALID_ENCRYPTED_CARD | INVALID_CARD | PAYMENT_AMOUNT_MISMATCH | GENERIC_DECLINE | CVV_FAILURE | ADDRESS_VERIFICATION_FAILURE | INVALID_ACCOUNT | CURRENCY_MISMATCH | INSUFFICIENT_FUNDS | INSUFFICIENT_PERMISSIONS | CARDHOLDER_INSUFFICIENT_PERMISSIONS | INVALID_LOCATION | TRANSACTION_LIMIT | VOICE_FAILURE | PAN_FAILURE | EXPIRATION_FAILURE | CARD_NOT_SUPPORTED | READER_DECLINED | INVALID_PIN | MISSING_PIN | MISSING_ACCOUNT_TYPE | INVALID_POSTAL_CODE | INVALID_FEES | MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED | PAYMENT_LIMIT_EXCEEDED | GIFT_CARD_AVAILABLE_AMOUNT | ACCOUNT_UNUSABLE | BUYER_REFUSED_PAYMENT | DELAYED_TRANSACTION_EXPIRED | DELAYED_TRANSACTION_CANCELED | DELAYED_TRANSACTION_CAPTURED | DELAYED_TRANSACTION_FAILED | CARD_TOKEN_EXPIRED | CARD_TOKEN_USED | AMOUNT_TOO_HIGH | AMOUNT_TOO_LOW | UNSUPPORTED_INSTRUMENT_TYPE | REFUND_AMOUNT_INVALID | REFUND_ALREADY_PENDING | PAYMENT_NOT_REFUNDABLE | PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE | REFUND_ERROR_PAYMENT_NEEDS_COMPLETION | REFUND_DECLINED | INSUFFICIENT_PERMISSIONS_FOR_REFUND | INVALID_CARD_DATA | SOURCE_USED | SOURCE_EXPIRED | UNSUPPORTED_LOYALTY_REWARD_TIER | LOCATION_MISMATCH | ORDER_UNPAID_NOT_RETURNABLE | PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED | IDEMPOTENCY_KEY_REUSED | UNEXPECTED_VALUE | SANDBOX_NOT_SUPPORTED | INVALID_EMAIL_ADDRESS | INVALID_PHONE_NUMBER | CHECKOUT_EXPIRED | BAD_CERTIFICATE | INVALID_SQUARE_VERSION_FORMAT | API_VERSION_INCOMPATIBLE | CARD_PRESENCE_REQUIRED | UNSUPPORTED_SOURCE_TYPE | CARD_MISMATCH | PLAID_ERROR | PLAID_ERROR_ITEM_LOGIN_REQUIRED | PLAID_ERROR_RATE_LIMIT | PLAID_ERROR_INVALID_ACCESS_TOKEN | PLAID_ERROR_INVALID_ACCOUNT_ID | PLAID_ERROR_NO_ACCOUNTS | PLAID_ERROR_ITEM_NOT_FOUND | PLAID_ERROR_INSUFFICIENT_CREDENTIALS | PLAID_ERROR_ITEM_NOT_SUPPORTED | PLAID_ERROR_PRODUCT_NOT_READY | PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET | CARD_DECLINED | VERIFY_CVV_FAILURE | VERIFY_AVS_FAILURE | CARD_DECLINED_CALL_ISSUER | CARD_DECLINED_VERIFICATION_REQUIRED | BAD_EXPIRATION | CHIP_INSERTION_REQUIRED | ALLOWABLE_PIN_TRIES_EXCEEDED | RESERVATION_DECLINED | UNKNOWN_BODY_PARAMETER | CART_INELIGIBLE_FOR_EBT | NOT_FOUND | APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND | METHOD_NOT_ALLOWED | NOT_ACCEPTABLE | REQUEST_TIMEOUT | CONFLICT | GONE | REQUEST_ENTITY_TOO_LARGE | UNSUPPORTED_MEDIA_TYPE | UNPROCESSABLE_ENTITY | RATE_LIMITED | NOT_IMPLEMENTED | BAD_GATEWAY | SERVICE_UNAVAILABLE | TEMPORARY_ERROR | GATEWAY_TIMEOUT,
detail?: string,
field?: string
}[]
},
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category: API_ERROR | AUTHENTICATION_ERROR | INVALID_REQUEST_ERROR | RATE_LIMIT_ERROR | PAYMENT_METHOD_ERROR | REFUND_ERROR | MERCHANT_SUBSCRIPTION_ERROR | EXTERNAL_VENDOR_ERROR,
code: INTERNAL_SERVER_ERROR | UNAUTHORIZED | ACCESS_TOKEN_EXPIRED | ACCESS_TOKEN_REVOKED | CLIENT_DISABLED | FORBIDDEN | INSUFFICIENT_SCOPES | APPLICATION_DISABLED | V1_APPLICATION | V1_ACCESS_TOKEN | CARD_PROCESSING_NOT_ENABLED | MERCHANT_SUBSCRIPTION_NOT_FOUND | BAD_REQUEST | MISSING_REQUIRED_PARAMETER | INCORRECT_TYPE | INVALID_TIME | INVALID_TIME_RANGE | INVALID_VALUE | INVALID_CURSOR | UNKNOWN_QUERY_PARAMETER | CONFLICTING_PARAMETERS | EXPECTED_JSON_BODY | INVALID_SORT_ORDER | VALUE_REGEX_MISMATCH | VALUE_TOO_SHORT | VALUE_TOO_LONG | VALUE_TOO_LOW | VALUE_TOO_HIGH | VALUE_EMPTY | ARRAY_LENGTH_TOO_LONG | ARRAY_LENGTH_TOO_SHORT | ARRAY_EMPTY | EXPECTED_BOOLEAN | EXPECTED_INTEGER | EXPECTED_FLOAT | EXPECTED_STRING | EXPECTED_OBJECT | EXPECTED_ARRAY | EXPECTED_MAP | EXPECTED_BASE64_ENCODED_BYTE_ARRAY | INVALID_ARRAY_VALUE | INVALID_ENUM_VALUE | INVALID_CONTENT_TYPE | INVALID_FORM_VALUE | CUSTOMER_NOT_FOUND | ONE_INSTRUMENT_EXPECTED | NO_FIELDS_SET | TOO_MANY_MAP_ENTRIES | MAP_KEY_LENGTH_TOO_SHORT | MAP_KEY_LENGTH_TOO_LONG | CUSTOMER_MISSING_NAME | CUSTOMER_MISSING_EMAIL | INVALID_PAUSE_LENGTH | INVALID_DATE | UNSUPPORTED_COUNTRY | UNSUPPORTED_CURRENCY | APPLE_TTP_PIN_TOKEN | CARD_EXPIRED | INVALID_EXPIRATION | INVALID_EXPIRATION_YEAR | INVALID_EXPIRATION_DATE | UNSUPPORTED_CARD_BRAND | UNSUPPORTED_ENTRY_METHOD | INVALID_ENCRYPTED_CARD | INVALID_CARD | PAYMENT_AMOUNT_MISMATCH | GENERIC_DECLINE | CVV_FAILURE | ADDRESS_VERIFICATION_FAILURE | INVALID_ACCOUNT | CURRENCY_MISMATCH | INSUFFICIENT_FUNDS | INSUFFICIENT_PERMISSIONS | CARDHOLDER_INSUFFICIENT_PERMISSIONS | INVALID_LOCATION | TRANSACTION_LIMIT | VOICE_FAILURE | PAN_FAILURE | EXPIRATION_FAILURE | CARD_NOT_SUPPORTED | READER_DECLINED | INVALID_PIN | MISSING_PIN | MISSING_ACCOUNT_TYPE | INVALID_POSTAL_CODE | INVALID_FEES | MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED | PAYMENT_LIMIT_EXCEEDED | GIFT_CARD_AVAILABLE_AMOUNT | ACCOUNT_UNUSABLE | BUYER_REFUSED_PAYMENT | DELAYED_TRANSACTION_EXPIRED | DELAYED_TRANSACTION_CANCELED | DELAYED_TRANSACTION_CAPTURED | DELAYED_TRANSACTION_FAILED | CARD_TOKEN_EXPIRED | CARD_TOKEN_USED | AMOUNT_TOO_HIGH | AMOUNT_TOO_LOW | UNSUPPORTED_INSTRUMENT_TYPE | REFUND_AMOUNT_INVALID | REFUND_ALREADY_PENDING | PAYMENT_NOT_REFUNDABLE | PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE | REFUND_ERROR_PAYMENT_NEEDS_COMPLETION | REFUND_DECLINED | INSUFFICIENT_PERMISSIONS_FOR_REFUND | INVALID_CARD_DATA | SOURCE_USED | SOURCE_EXPIRED | UNSUPPORTED_LOYALTY_REWARD_TIER | LOCATION_MISMATCH | ORDER_UNPAID_NOT_RETURNABLE | PARTIAL_PAYMENT_DELAY_CAPTURE_NOT_SUPPORTED | IDEMPOTENCY_KEY_REUSED | UNEXPECTED_VALUE | SANDBOX_NOT_SUPPORTED | INVALID_EMAIL_ADDRESS | INVALID_PHONE_NUMBER | CHECKOUT_EXPIRED | BAD_CERTIFICATE | INVALID_SQUARE_VERSION_FORMAT | API_VERSION_INCOMPATIBLE | CARD_PRESENCE_REQUIRED | UNSUPPORTED_SOURCE_TYPE | CARD_MISMATCH | PLAID_ERROR | PLAID_ERROR_ITEM_LOGIN_REQUIRED | PLAID_ERROR_RATE_LIMIT | PLAID_ERROR_INVALID_ACCESS_TOKEN | PLAID_ERROR_INVALID_ACCOUNT_ID | PLAID_ERROR_NO_ACCOUNTS | PLAID_ERROR_ITEM_NOT_FOUND | PLAID_ERROR_INSUFFICIENT_CREDENTIALS | PLAID_ERROR_ITEM_NOT_SUPPORTED | PLAID_ERROR_PRODUCT_NOT_READY | PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET | CARD_DECLINED | VERIFY_CVV_FAILURE | VERIFY_AVS_FAILURE | CARD_DECLINED_CALL_ISSUER | CARD_DECLINED_VERIFICATION_REQUIRED | BAD_EXPIRATION | CHIP_INSERTION_REQUIRED | ALLOWABLE_PIN_TRIES_EXCEEDED | RESERVATION_DECLINED | UNKNOWN_BODY_PARAMETER | CART_INELIGIBLE_FOR_EBT | NOT_FOUND | APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND | METHOD_NOT_ALLOWED | NOT_ACCEPTABLE | REQUEST_TIMEOUT | CONFLICT | GONE | REQUEST_ENTITY_TOO_LARGE | UNSUPPORTED_MEDIA_TYPE | UNPROCESSABLE_ENTITY | RATE_LIMITED | NOT_IMPLEMENTED | BAD_GATEWAY | SERVICE_UNAVAILABLE | TEMPORARY_ERROR | GATEWAY_TIMEOUT,
detail?: string,
field?: string
}[] | null
},
location_id?: string,
order_id?: string,
reference_id?: string,
customer_id?: string,
employee_id?: string,
team_member_id?: string | null,
refund_ids?: string[],
risk_evaluation?: {
created_at?: string,
risk_level?: PENDING | NORMAL | MODERATE | HIGH
},
terminal_checkout_id?: string,
buyer_email_address?: string,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: ZZ | AD | AE | AF | AG | AI | AL | AM | AO | AQ | AR | AS | AT | AU | AW | AX | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BQ | BR | BS | BT | BV | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GF | GG | GH | GI | GL | GM | GN | GP | GQ | GR | GS | GT | GU | GW | GY | HK | HM | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MQ | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NF | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PS | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | SS | ST | SV | SX | SY | SZ | TC | TD | TF | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | UM | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW,
first_name?: string | null,
last_name?: string | null
},
note?: string,
statement_description_identifier?: string,
capabilities?: string[],
receipt_number?: string,
receipt_url?: string,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
},
application_details?: {
square_product?: APPOINTMENTS | ECOMMERCE_API | INVOICES | ONLINE_STORE | OTHER | RESTAURANTS | RETAIL | SQUARE_POS | TERMINAL_API | VIRTUAL_TERMINAL,
application_id?: string | null
},
buyer_currency_exchange?: Record<string, any>,
is_offline_payment?: boolean,
offline_payment_details?: {
client_created_at?: string
},
version_token?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
payment | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
payment full type
payment full type
{
id?: string | null,
created_at?: string | null,
updated_at?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
tip_money?: {
amount?: number | null,
currency?: string | null
} | null,
total_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
approved_money?: {
amount?: number | null,
currency?: string | null
} | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
refunded_money?: {
amount?: number | null,
currency?: string | null
} | null,
status?: string | null,
delay_duration?: string | null,
delay_action?: string | null,
delayed_until?: string | null,
source_type?: string | null,
card_details?: {
status?: string | null,
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
cvv_status?: string | null,
avs_status?: string | null,
auth_result_code?: string | null,
application_identifier?: string | null,
application_name?: string | null,
application_cryptogram?: string | null,
verification_method?: string | null,
verification_results?: string | null,
statement_description?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
card_payment_timeline?: {
authorized_at?: string | null,
captured_at?: string | null,
voided_at?: string | null
} | null,
refund_requires_card_presence?: boolean | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null,
applied_card_surcharge_details?: {
card_surcharge_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_type?: string | null
} | null,
cash_details?: {
buyer_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
bank_account_details?: {
bank_name?: string | null,
transfer_type?: string | null,
account_ownership_type?: string | null,
fingerprint?: string | null,
country?: string | null,
statement_description?: string | null,
ach_details?: {
routing_number?: string | null,
account_number_suffix?: string | null,
account_type?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
electronic_money_details?: {
felica_details?: {
terminal_id?: string | null,
felica_masked_card_number?: string | null,
felica_brand?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null,
source_fee_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
wallet_details?: {
status?: string | null,
brand?: string | null,
cash_app_details?: {
buyer_full_name?: string | null,
buyer_country_code?: string | null,
buyer_cashtag?: string | null
} | null,
lightning_details?: {
payment_url?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
buy_now_pay_later_details?: {
brand?: string | null,
afterpay_details?: {
email_address?: string | null
} | null,
clearpay_details?: {
email_address?: string | null
} | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
square_account_details?: {
payment_source_token?: string | null,
errors?: {
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
} | null,
location_id?: string | null,
order_id?: string | null,
reference_id?: string | null,
customer_id?: string | null,
employee_id?: string | null,
team_member_id?: string | null,
refund_ids?: string[] | null,
risk_evaluation?: {
created_at?: string | null,
risk_level?: string | null
} | null,
terminal_checkout_id?: string | null,
buyer_email_address?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
shipping_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
note?: string | null,
statement_description_identifier?: string | null,
capabilities?: string[] | null,
receipt_number?: string | null,
receipt_url?: string | null,
device_details?: {
device_id?: string | null,
device_installation_id?: string | null,
device_name?: string | null
} | null,
application_details?: {
square_product?: string | null,
application_id?: string | null
} | null,
buyer_currency_exchange?: Record<string, any> | null,
is_offline_payment?: boolean | null,
offline_payment_details?: {
client_created_at?: string | null
} | null,
version_token?: string | null
} | null
Refunds
get
refunds.get
Retrieves a specific refund using the refund_id.
Risk: read
await corsair.square.api.refunds.get({ refund_id: '<refund id>' });
| Name | Type | Required | Description |
|---|---|---|---|
refund_id | string | Yes | The unique ID for the desired PaymentRefund. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
refund | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
refund full type
refund full type
{
id?: string | null,
status?: string | null,
location_id?: string | null,
unlinked?: boolean | null,
destination_type?: string | null,
destination_details?: {
card_details?: {
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
auth_result_code?: string | null
} | null,
cash_details?: {
seller_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null
} | null
} | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
payment_id?: string | null,
order_id?: string | null,
reason?: string | null,
created_at?: string | null,
updated_at?: string | null,
team_member_id?: string | null,
terminal_refund_id?: string | null
} | null
list
refunds.list
Retrieves a list of refunds for the account making the request.
Risk: read
await corsair.square.api.refunds.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
begin_time | string | No | Indicates the start of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the created_at field for each PaymentRefund. |
end_time | string | No | Indicates the end of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the created_at field for each PaymentRefund. |
sort_order | string | No | The order in which results are listed by PaymentRefund.created_at: - ASC - Oldest to newest. - DESC - Newest to oldest (default). |
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. |
location_id | string | No | Limit results to the location supplied. By default, results are returned for all locations associated with the seller. |
status | string | No | If provided, only refunds with the given status are returned. For a list of refund status values, see PaymentRefund. |
source_type | string | No | If provided, only returns refunds whose payments have the indicated source type. Current values include CARD, BANK_ACCOUNT, WALLET, CASH, and EXTERNAL. |
limit | number | No | The maximum number of results to be returned in a single page. |
updated_at_begin_time | string | No | Indicates the start of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the updated_at field for each PaymentRefund. |
updated_at_end_time | string | No | Indicates the end of the time range to retrieve each PaymentRefund for, in RFC 3339 format. The range is determined using the updated_at field for each PaymentRefund. |
sort_field | CREATED_AT | UPDATED_AT | No | The field used to sort results by. The default is CREATED_AT. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
refunds | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
refunds full type
refunds full type
{
id?: string | null,
status?: string | null,
location_id?: string | null,
unlinked?: boolean | null,
destination_type?: string | null,
destination_details?: {
card_details?: {
card?: {
id?: string | null,
card_brand?: string | null,
last_4?: string | null,
exp_month?: number | null,
exp_year?: number | null,
cardholder_name?: string | null,
billing_address?: {
address_line_1?: string | null,
address_line_2?: string | null,
address_line_3?: string | null,
locality?: string | null,
sublocality?: string | null,
sublocality_2?: string | null,
sublocality_3?: string | null,
administrative_district_level_1?: string | null,
administrative_district_level_2?: string | null,
administrative_district_level_3?: string | null,
postal_code?: string | null,
country?: string | null,
first_name?: string | null,
last_name?: string | null
} | null,
fingerprint?: string | null,
customer_id?: string | null,
merchant_id?: string | null,
reference_id?: string | null,
enabled?: boolean | null,
card_type?: string | null,
prepaid_type?: string | null,
bin?: string | null,
created_at?: string | null,
disabled_at?: string | null,
version?: number | null,
card_co_brand?: string | null,
issuer_alert?: string | null,
issuer_alert_at?: string | null,
hsa_fsa?: boolean | null
} | null,
entry_method?: string | null,
auth_result_code?: string | null
} | null,
cash_details?: {
seller_supplied_money?: {
amount?: number | null,
currency?: string | null
} | null,
change_back_money?: {
amount?: number | null,
currency?: string | null
} | null
} | null,
external_details?: {
type?: string | null,
source?: string | null,
source_id?: string | null
} | null
} | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_money?: {
amount?: number | null,
currency?: string | null
} | null,
app_fee_allocations?: Record<string, any>[] | null,
processing_fee?: {
effective_at?: string | null,
type?: string | null,
amount_money?: {
amount?: number | null,
currency?: string | null
} | null
}[] | null,
payment_id?: string | null,
order_id?: string | null,
reason?: string | null,
created_at?: string | null,
updated_at?: string | null,
team_member_id?: string | null,
terminal_refund_id?: string | null
}[] | null
Webhook Event Types
list
webhookEventTypes.list
Lists all webhook event types that can be subscribed to.
Risk: read
await corsair.square.api.webhookEventTypes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
api_version | string | No | The API version for which to list event types. Setting this field overrides the default version used by the application. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
event_types | string[] | null | No | — |
metadata | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
metadata full type
metadata full type
{
event_type?: string | null,
api_version_introduced?: string | null,
release_status?: string | null
}[] | null
Webhook Subscriptions
create
webhookSubscriptions.create
Creates a webhook subscription. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.webhookSubscriptions.create({
subscription: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | No | A unique string that identifies the CreateWebhookSubscription request. |
subscription | object | Yes | The Subscription to create. |
subscription full type
subscription full type
{
id?: string,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string,
created_at?: string,
updated_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
subscription | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
subscription full type
subscription full type
{
id?: string | null,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
delete
webhookSubscriptions.delete
Deletes a webhook subscription. Cannot be undone.
Risk: destructive · Irreversible
await corsair.square.api.webhookSubscriptions.delete({ subscription_id: '<subscription id>' });
| Name | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | [REQUIRED] The ID of the Subscription to delete. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
get
webhookSubscriptions.get
Retrieves a webhook subscription identified by its ID.
Risk: read
await corsair.square.api.webhookSubscriptions.get({ subscription_id: '<subscription id>' });
| Name | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | [REQUIRED] The ID of the Subscription to retrieve. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
subscription | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
subscription full type
subscription full type
{
id?: string | null,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
list
webhookSubscriptions.list
Lists all webhook subscriptions owned by your application.
Risk: read
await corsair.square.api.webhookSubscriptions.list({ cursor: '<cursor>', limit: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. |
include_disabled | boolean | No | Includes disabled Subscriptions. By default, all enabled Subscriptions are returned. |
sort_order | DESC | ASC | No | Sorts the returned list by when the Subscription was created with the specified order. This field defaults to ASC. |
limit | number | No | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
subscriptions | object[] | null | No | — |
cursor | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
subscriptions full type
subscriptions full type
{
id?: string | null,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string | null,
created_at?: string | null,
updated_at?: string | null
}[] | null
test
webhookSubscriptions.test
Tests a webhook subscription by sending a test event to the notification URL.
Risk: destructive
await corsair.square.api.webhookSubscriptions.test({ subscription_id: '<subscription id>' });
| Name | Type | Required | Description |
|---|---|---|---|
event_type | string | null | No | The event type that will be used to test the Subscription. The event type must be contained in the list of event types in the Subscription. |
subscription_id | string | Yes | [REQUIRED] The ID of the Subscription to test. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
subscription_test_result | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
subscription_test_result full type
subscription_test_result full type
{
id?: string | null,
status_code?: number | null,
payload?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
update
webhookSubscriptions.update
Updates a webhook subscription.
Risk: write
await corsair.square.api.webhookSubscriptions.update({ subscription_id: '<subscription id>' });
| Name | Type | Required | Description |
|---|---|---|---|
subscription | object | No | The Subscription to update. |
subscription_id | string | Yes | [REQUIRED] The ID of the Subscription to update. |
subscription full type
subscription full type
{
id?: string,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string,
created_at?: string,
updated_at?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
subscription | object | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null
subscription full type
subscription full type
{
id?: string | null,
name?: string | null,
enabled?: boolean | null,
event_types?: string[] | null,
notification_url?: string | null,
api_version?: string | null,
signature_key?: string | null,
created_at?: string | null,
updated_at?: string | null
} | null
updateSignatureKey
webhookSubscriptions.updateSignatureKey
Updates a webhook subscription by replacing the existing signature key with a new one. The old signature key stops verifying as soon as the new one is issued. Pass the same idempotency_key to retry safely.
Risk: write
await corsair.square.api.webhookSubscriptions.updateSignatureKey({ subscription_id: '<subscription id>' });
| Name | Type | Required | Description |
|---|---|---|---|
idempotency_key | string | null | No | A unique string that identifies the UpdateWebhookSubscriptionSignatureKey request. |
subscription_id | string | Yes | [REQUIRED] The ID of the Subscription to update. |
| Name | Type | Required | Description |
|---|---|---|---|
errors | object[] | null | No | — |
signature_key | string | null | No | — |
errors full type
errors full type
{
category?: string | null,
code?: string | null,
detail?: string | null,
field?: string | null
}[] | null