SquareUp.TypeSpecs (SquareUp v0.1.1) View Source

Link to this section Summary

Types

Link to this section Types

Link to this type

accept_dispute_request()

View Source

Specs

accept_dispute_request() :: %{}
Link to this type

accept_dispute_response()

View Source

Specs

accept_dispute_response() :: %{
  optional(:dispute) => dispute(),
  optional(:errors) => [error()]
}
Link to this type

accumulate_loyalty_points_request()

View Source

Specs

accumulate_loyalty_points_request() :: %{
  accumulate_points: loyalty_event_accumulate_points(),
  idempotency_key: binary(),
  location_id: binary()
}
Link to this type

accumulate_loyalty_points_response()

View Source

Specs

accumulate_loyalty_points_response() :: %{
  optional(:errors) => [error()],
  optional(:event) => loyalty_event()
}
Link to this type

action_cancel_reason()

View Source

Specs

action_cancel_reason() :: binary()
Link to this type

add_group_to_customer_request()

View Source

Specs

add_group_to_customer_request() :: %{}
Link to this type

add_group_to_customer_response()

View Source

Specs

add_group_to_customer_response() :: %{optional(:errors) => [error()]}
Link to this type

additional_recipient()

View Source

Specs

additional_recipient() :: %{
  :amount_money => money(),
  :description => binary(),
  :location_id => binary(),
  optional(:receivable_id) => binary()
}

Specs

address() :: %{
  optional(:address_line_1) => binary(),
  optional(:address_line_2) => binary(),
  optional(:address_line_3) => binary(),
  optional(:administrative_district_level_1) => binary(),
  optional(:administrative_district_level_2) => binary(),
  optional(:administrative_district_level_3) => binary(),
  optional(:country) => binary(),
  optional(:first_name) => binary(),
  optional(:last_name) => binary(),
  optional(:locality) => binary(),
  optional(:organization) => binary(),
  optional(:postal_code) => binary(),
  optional(:sublocality) => binary(),
  optional(:sublocality_2) => binary(),
  optional(:sublocality_3) => binary()
}
Link to this type

adjust_loyalty_points_request()

View Source

Specs

adjust_loyalty_points_request() :: %{
  adjust_points: loyalty_event_adjust_points(),
  idempotency_key: binary()
}
Link to this type

adjust_loyalty_points_response()

View Source

Specs

adjust_loyalty_points_response() :: %{
  optional(:errors) => [error()],
  optional(:event) => loyalty_event()
}
Link to this type

balance_payment_details()

View Source

Specs

balance_payment_details() :: %{
  optional(:account_id) => binary(),
  optional(:status) => binary()
}

Specs

bank_account() :: %{
  :account_number_suffix => binary(),
  :account_type => binary(),
  optional(:bank_name) => binary(),
  :country => binary(),
  :creditable => boolean(),
  :currency => binary(),
  optional(:debit_mandate_reference_id) => binary(),
  :debitable => boolean(),
  optional(:fingerprint) => binary(),
  :holder_name => binary(),
  :id => binary(),
  optional(:location_id) => binary(),
  :primary_bank_identification_number => binary(),
  optional(:reference_id) => binary(),
  optional(:secondary_bank_identification_number) => binary(),
  :status => binary(),
  optional(:version) => integer()
}

Specs

bank_account_status() :: binary()

Specs

bank_account_type() :: binary()
Link to this type

batch_change_inventory_request()

View Source

Specs

batch_change_inventory_request() :: %{
  optional(:changes) => [inventory_change()],
  optional(:idempotency_key) => binary(),
  optional(:ignore_unchanged_counts) => boolean()
}
Link to this type

batch_change_inventory_response()

View Source

Specs

batch_change_inventory_response() :: %{
  optional(:counts) => [inventory_count()],
  optional(:errors) => [error()]
}
Link to this type

batch_delete_catalog_objects_request()

View Source

Specs

batch_delete_catalog_objects_request() :: %{optional(:object_ids) => [binary()]}
Link to this type

batch_delete_catalog_objects_response()

View Source

Specs

batch_delete_catalog_objects_response() :: %{
  optional(:deleted_at) => binary(),
  optional(:deleted_object_ids) => [binary()],
  optional(:errors) => [error()]
}
Link to this type

batch_retrieve_catalog_objects_request()

View Source

Specs

batch_retrieve_catalog_objects_request() :: %{
  optional(:include_related_objects) => boolean(),
  :object_ids => [binary()]
}
Link to this type

batch_retrieve_catalog_objects_response()

View Source

Specs

batch_retrieve_catalog_objects_response() :: %{
  optional(:errors) => [error()],
  optional(:objects) => [catalog_object()],
  optional(:related_objects) => [catalog_object()]
}
Link to this type

batch_retrieve_inventory_changes_request()

View Source

Specs

batch_retrieve_inventory_changes_request() :: %{
  optional(:catalog_object_ids) => [binary()],
  optional(:cursor) => binary(),
  optional(:location_ids) => [binary()],
  optional(:states) => [binary()],
  optional(:types) => [binary()],
  optional(:updated_after) => binary(),
  optional(:updated_before) => binary()
}
Link to this type

batch_retrieve_inventory_changes_response()

View Source

Specs

batch_retrieve_inventory_changes_response() :: %{
  optional(:changes) => [inventory_change()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

batch_retrieve_inventory_counts_request()

View Source

Specs

batch_retrieve_inventory_counts_request() :: %{
  optional(:catalog_object_ids) => [binary()],
  optional(:cursor) => binary(),
  optional(:location_ids) => [binary()],
  optional(:states) => [binary()],
  optional(:updated_after) => binary()
}
Link to this type

batch_retrieve_inventory_counts_response()

View Source

Specs

batch_retrieve_inventory_counts_response() :: %{
  optional(:counts) => [inventory_count()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

batch_retrieve_orders_request()

View Source

Specs

batch_retrieve_orders_request() :: %{
  optional(:location_id) => binary(),
  :order_ids => [binary()]
}
Link to this type

batch_retrieve_orders_response()

View Source

Specs

batch_retrieve_orders_response() :: %{
  optional(:errors) => [error()],
  optional(:orders) => [order()]
}
Link to this type

batch_upsert_catalog_objects_request()

View Source

Specs

batch_upsert_catalog_objects_request() :: %{
  batches: [catalog_object_batch()],
  idempotency_key: binary()
}
Link to this type

batch_upsert_catalog_objects_response()

View Source

Specs

batch_upsert_catalog_objects_response() :: %{
  optional(:errors) => [error()],
  optional(:id_mappings) => [catalog_id_mapping()],
  optional(:objects) => [catalog_object()],
  optional(:updated_at) => binary()
}

Specs

break() :: %{
  :break_type_id => binary(),
  optional(:end_at) => binary(),
  :expected_duration => binary(),
  optional(:id) => binary(),
  :is_paid => boolean(),
  :name => binary(),
  :start_at => binary()
}

Specs

break_type() :: %{
  :break_name => binary(),
  optional(:created_at) => binary(),
  :expected_duration => binary(),
  optional(:id) => binary(),
  :is_paid => boolean(),
  :location_id => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}
Link to this type

bulk_create_team_members_request()

View Source

Specs

bulk_create_team_members_request() :: %{team_members: map()}
Link to this type

bulk_create_team_members_response()

View Source

Specs

bulk_create_team_members_response() :: %{
  optional(:errors) => [error()],
  optional(:team_members) => map()
}
Link to this type

bulk_update_team_members_request()

View Source

Specs

bulk_update_team_members_request() :: %{team_members: map()}
Link to this type

bulk_update_team_members_response()

View Source

Specs

bulk_update_team_members_response() :: %{
  optional(:errors) => [error()],
  optional(:team_members) => map()
}

Specs

business_hours() :: %{optional(:periods) => [business_hours_period()]}
Link to this type

business_hours_period()

View Source

Specs

business_hours_period() :: %{
  optional(:day_of_week) => binary(),
  optional(:end_local_time) => binary(),
  optional(:start_local_time) => binary()
}
Link to this type

calculate_loyalty_points_request()

View Source

Specs

calculate_loyalty_points_request() :: %{
  optional(:order_id) => binary(),
  optional(:transaction_amount_money) => money()
}
Link to this type

calculate_loyalty_points_response()

View Source

Specs

calculate_loyalty_points_response() :: %{
  optional(:errors) => [error()],
  optional(:points) => integer()
}
Link to this type

calculate_order_request()

View Source

Specs

calculate_order_request() :: %{
  :order => order(),
  optional(:proposed_rewards) => [order_reward()]
}
Link to this type

calculate_order_response()

View Source

Specs

calculate_order_response() :: %{
  optional(:errors) => [error()],
  optional(:order) => order()
}
Link to this type

cancel_invoice_request()

View Source

Specs

cancel_invoice_request() :: %{version: integer()}
Link to this type

cancel_invoice_response()

View Source

Specs

cancel_invoice_response() :: %{
  optional(:errors) => [error()],
  optional(:invoice) => invoice()
}
Link to this type

cancel_payment_by_idempotency_key_request()

View Source

Specs

cancel_payment_by_idempotency_key_request() :: %{idempotency_key: binary()}
Link to this type

cancel_payment_by_idempotency_key_response()

View Source

Specs

cancel_payment_by_idempotency_key_response() :: %{
  optional(:errors) => [error()]
}
Link to this type

cancel_payment_request()

View Source

Specs

cancel_payment_request() :: %{}
Link to this type

cancel_payment_response()

View Source

Specs

cancel_payment_response() :: %{
  optional(:errors) => [error()],
  optional(:payment) => payment()
}
Link to this type

cancel_subscription_request()

View Source

Specs

cancel_subscription_request() :: %{}
Link to this type

cancel_subscription_response()

View Source

Specs

cancel_subscription_response() :: %{
  optional(:errors) => [error()],
  optional(:subscription) => subscription()
}
Link to this type

cancel_terminal_checkout_request()

View Source

Specs

cancel_terminal_checkout_request() :: %{}
Link to this type

cancel_terminal_checkout_response()

View Source

Specs

cancel_terminal_checkout_response() :: %{
  optional(:checkout) => terminal_checkout(),
  optional(:errors) => [error()]
}
Link to this type

capture_transaction_request()

View Source

Specs

capture_transaction_request() :: %{}
Link to this type

capture_transaction_response()

View Source

Specs

capture_transaction_response() :: %{optional(:errors) => [error()]}

Specs

card() :: %{
  optional(:billing_address) => address(),
  optional(:bin) => binary(),
  optional(:card_brand) => binary(),
  optional(:card_type) => binary(),
  optional(:cardholder_name) => binary(),
  optional(:exp_month) => integer(),
  optional(:exp_year) => integer(),
  optional(:fingerprint) => binary(),
  optional(:id) => binary(),
  optional(:last_4) => binary(),
  optional(:prepaid_type) => binary()
}

Specs

card_brand() :: binary()
Link to this type

card_payment_details()

View Source

Specs

card_payment_details() :: %{
  optional(:application_cryptogram) => binary(),
  optional(:application_identifier) => binary(),
  optional(:application_name) => binary(),
  optional(:auth_result_code) => binary(),
  optional(:avs_status) => binary(),
  optional(:card) => card(),
  optional(:cvv_status) => binary(),
  optional(:device_details) => device_details(),
  optional(:entry_method) => binary(),
  optional(:errors) => [error()],
  optional(:refund_requires_card_presence) => boolean(),
  optional(:statement_description) => binary(),
  optional(:status) => binary(),
  optional(:verification_method) => binary(),
  optional(:verification_results) => binary()
}

Specs

card_prepaid_type() :: binary()

Specs

card_square_product() :: binary()

Specs

card_type() :: binary()

Specs

cash_drawer_device() :: %{
  optional(:id) => binary(),
  optional(:name) => binary()
}
Link to this type

cash_drawer_event_type()

View Source

Specs

cash_drawer_event_type() :: binary()

Specs

cash_drawer_shift() :: %{
  optional(:cash_paid_in_money) => money(),
  optional(:cash_paid_out_money) => money(),
  optional(:cash_payment_money) => money(),
  optional(:cash_refunds_money) => money(),
  optional(:closed_at) => binary(),
  optional(:closed_cash_money) => money(),
  optional(:closing_employee_id) => binary(),
  optional(:description) => binary(),
  optional(:device) => cash_drawer_device(),
  optional(:employee_ids) => [binary()],
  optional(:ended_at) => binary(),
  optional(:ending_employee_id) => binary(),
  optional(:expected_cash_money) => money(),
  optional(:id) => binary(),
  optional(:opened_at) => binary(),
  optional(:opened_cash_money) => money(),
  optional(:opening_employee_id) => binary(),
  optional(:state) => binary()
}
Link to this type

cash_drawer_shift_event()

View Source

Specs

cash_drawer_shift_event() :: %{
  optional(:created_at) => binary(),
  optional(:description) => binary(),
  optional(:employee_id) => binary(),
  optional(:event_money) => money(),
  optional(:event_type) => binary(),
  optional(:id) => binary()
}
Link to this type

cash_drawer_shift_state()

View Source

Specs

cash_drawer_shift_state() :: binary()
Link to this type

cash_drawer_shift_summary()

View Source

Specs

cash_drawer_shift_summary() :: %{
  optional(:closed_at) => binary(),
  optional(:closed_cash_money) => money(),
  optional(:description) => binary(),
  optional(:ended_at) => binary(),
  optional(:expected_cash_money) => money(),
  optional(:id) => binary(),
  optional(:opened_at) => binary(),
  optional(:opened_cash_money) => money(),
  optional(:state) => binary()
}

Specs

catalog_category() :: %{optional(:name) => binary()}
Link to this type

catalog_custom_attribute_definition()

View Source

Specs

catalog_custom_attribute_definition() :: %{
  :allowed_object_types => [binary()],
  optional(:app_visibility) => binary(),
  optional(:custom_attribute_usage_count) => integer(),
  optional(:description) => binary(),
  optional(:key) => binary(),
  :name => binary(),
  optional(:number_config) =>
    catalog_custom_attribute_definition_number_config(),
  optional(:selection_config) =>
    catalog_custom_attribute_definition_selection_config(),
  optional(:seller_visibility) => binary(),
  optional(:source_application) => source_application(),
  optional(:string_config) =>
    catalog_custom_attribute_definition_string_config(),
  :type => binary()
}
Link to this type

catalog_custom_attribute_definition_app_visibility()

View Source

Specs

catalog_custom_attribute_definition_app_visibility() :: binary()
Link to this type

catalog_custom_attribute_definition_number_config()

View Source

Specs

catalog_custom_attribute_definition_number_config() :: %{
  optional(:precision) => integer()
}
Link to this type

catalog_custom_attribute_definition_selection_config()

View Source

Specs

catalog_custom_attribute_definition_selection_config() :: %{
  optional(:allowed_selections) => [
    catalog_custom_attribute_definition_selection_config_custom_attribute_selection()
  ],
  optional(:max_allowed_selections) => integer()
}
Link to this type

catalog_custom_attribute_definition_selection_config_custom_attribute_selection()

View Source

Specs

catalog_custom_attribute_definition_selection_config_custom_attribute_selection() ::
  %{:name => binary(), optional(:uid) => binary()}
Link to this type

catalog_custom_attribute_definition_seller_visibility()

View Source

Specs

catalog_custom_attribute_definition_seller_visibility() :: binary()
Link to this type

catalog_custom_attribute_definition_string_config()

View Source

Specs

catalog_custom_attribute_definition_string_config() :: %{
  optional(:enforce_uniqueness) => boolean()
}
Link to this type

catalog_custom_attribute_definition_type()

View Source

Specs

catalog_custom_attribute_definition_type() :: binary()
Link to this type

catalog_custom_attribute_value()

View Source

Specs

catalog_custom_attribute_value() :: %{
  optional(:boolean_value) => boolean(),
  optional(:custom_attribute_definition_id) => binary(),
  optional(:key) => binary(),
  optional(:name) => binary(),
  optional(:number_value) => binary(),
  optional(:selection_uid_values) => [binary()],
  optional(:string_value) => binary(),
  optional(:type) => binary()
}

Specs

catalog_discount() :: %{
  optional(:amount_money) => money(),
  optional(:discount_type) => binary(),
  optional(:label_color) => binary(),
  optional(:modify_tax_basis) => binary(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:pin_required) => boolean()
}
Link to this type

catalog_discount_modify_tax_basis()

View Source

Specs

catalog_discount_modify_tax_basis() :: binary()
Link to this type

catalog_discount_type()

View Source

Specs

catalog_discount_type() :: binary()

Specs

catalog_id_mapping() :: %{
  optional(:client_object_id) => binary(),
  optional(:object_id) => binary()
}

Specs

catalog_image() :: %{
  optional(:caption) => binary(),
  optional(:name) => binary(),
  optional(:url) => binary()
}
Link to this type

catalog_info_request()

View Source

Specs

catalog_info_request() :: %{}
Link to this type

catalog_info_response()

View Source

Specs

catalog_info_response() :: %{
  optional(:errors) => [error()],
  optional(:limits) => catalog_info_response_limits(),
  optional(:standard_unit_description_group) =>
    standard_unit_description_group()
}
Link to this type

catalog_info_response_limits()

View Source

Specs

catalog_info_response_limits() :: %{
  optional(:batch_delete_max_object_ids) => integer(),
  optional(:batch_retrieve_max_object_ids) => integer(),
  optional(:batch_upsert_max_objects_per_batch) => integer(),
  optional(:batch_upsert_max_total_objects) => integer(),
  optional(:search_max_page_limit) => integer(),
  optional(:update_item_modifier_lists_max_item_ids) => integer(),
  optional(:update_item_modifier_lists_max_modifier_lists_to_disable) =>
    integer(),
  optional(:update_item_modifier_lists_max_modifier_lists_to_enable) =>
    integer(),
  optional(:update_item_taxes_max_item_ids) => integer(),
  optional(:update_item_taxes_max_taxes_to_disable) => integer(),
  optional(:update_item_taxes_max_taxes_to_enable) => integer()
}

Specs

catalog_item() :: %{
  optional(:abbreviation) => binary(),
  optional(:available_electronically) => boolean(),
  optional(:available_for_pickup) => boolean(),
  optional(:available_online) => boolean(),
  optional(:category_id) => binary(),
  optional(:description) => binary(),
  optional(:item_options) => [catalog_item_option_for_item()],
  optional(:label_color) => binary(),
  optional(:modifier_list_info) => [catalog_item_modifier_list_info()],
  optional(:name) => binary(),
  optional(:product_type) => binary(),
  optional(:skip_modifier_screen) => boolean(),
  optional(:tax_ids) => [binary()],
  optional(:variations) => [catalog_object()]
}
Link to this type

catalog_item_modifier_list_info()

View Source

Specs

catalog_item_modifier_list_info() :: %{
  optional(:enabled) => boolean(),
  optional(:max_selected_modifiers) => integer(),
  optional(:min_selected_modifiers) => integer(),
  :modifier_list_id => binary(),
  optional(:modifier_overrides) => [catalog_modifier_override()]
}

Specs

catalog_item_option() :: %{
  optional(:description) => binary(),
  optional(:display_name) => binary(),
  optional(:item_count) => integer(),
  optional(:name) => binary(),
  optional(:show_colors) => boolean(),
  optional(:values) => [catalog_object()]
}
Link to this type

catalog_item_option_for_item()

View Source

Specs

catalog_item_option_for_item() :: %{optional(:item_option_id) => binary()}
Link to this type

catalog_item_option_value()

View Source

Specs

catalog_item_option_value() :: %{
  optional(:color) => binary(),
  optional(:description) => binary(),
  optional(:item_option_id) => binary(),
  optional(:item_variation_count) => integer(),
  optional(:name) => binary(),
  optional(:ordinal) => integer()
}
Link to this type

catalog_item_option_value_for_item_variation()

View Source

Specs

catalog_item_option_value_for_item_variation() :: %{
  optional(:item_option_id) => binary(),
  optional(:item_option_value_id) => binary()
}
Link to this type

catalog_item_product_type()

View Source

Specs

catalog_item_product_type() :: binary()
Link to this type

catalog_item_variation()

View Source

Specs

catalog_item_variation() :: %{
  optional(:inventory_alert_threshold) => integer(),
  optional(:inventory_alert_type) => binary(),
  optional(:item_id) => binary(),
  optional(:item_option_values) => [
    catalog_item_option_value_for_item_variation()
  ],
  optional(:location_overrides) => [item_variation_location_overrides()],
  optional(:measurement_unit_id) => binary(),
  optional(:name) => binary(),
  optional(:ordinal) => integer(),
  optional(:price_money) => money(),
  optional(:pricing_type) => binary(),
  optional(:service_duration) => integer(),
  optional(:sku) => binary(),
  optional(:track_inventory) => boolean(),
  optional(:upc) => binary(),
  optional(:user_data) => binary()
}
Link to this type

catalog_measurement_unit()

View Source

Specs

catalog_measurement_unit() :: %{
  optional(:measurement_unit) => measurement_unit(),
  optional(:precision) => integer()
}

Specs

catalog_modifier() :: %{
  optional(:modifier_list_id) => binary(),
  optional(:name) => binary(),
  optional(:ordinal) => integer(),
  optional(:price_money) => money()
}
Link to this type

catalog_modifier_list()

View Source

Specs

catalog_modifier_list() :: %{
  optional(:modifiers) => [catalog_object()],
  optional(:name) => binary(),
  optional(:ordinal) => integer(),
  optional(:selection_type) => binary()
}
Link to this type

catalog_modifier_list_selection_type()

View Source

Specs

catalog_modifier_list_selection_type() :: binary()
Link to this type

catalog_modifier_override()

View Source

Specs

catalog_modifier_override() :: %{
  :modifier_id => binary(),
  optional(:on_by_default) => boolean()
}

Specs

catalog_object() :: %{
  optional(:absent_at_location_ids) => [binary()],
  optional(:catalog_v1_ids) => [catalog_v1_id()],
  optional(:category_data) => catalog_category(),
  optional(:custom_attribute_definition_data) =>
    catalog_custom_attribute_definition(),
  optional(:custom_attribute_values) => map(),
  optional(:discount_data) => catalog_discount(),
  :id => binary(),
  optional(:image_data) => catalog_image(),
  optional(:image_id) => binary(),
  optional(:is_deleted) => boolean(),
  optional(:item_data) => catalog_item(),
  optional(:item_option_data) => catalog_item_option(),
  optional(:item_option_value_data) => catalog_item_option_value(),
  optional(:item_variation_data) => catalog_item_variation(),
  optional(:measurement_unit_data) => catalog_measurement_unit(),
  optional(:modifier_data) => catalog_modifier(),
  optional(:modifier_list_data) => catalog_modifier_list(),
  optional(:present_at_all_locations) => boolean(),
  optional(:present_at_location_ids) => [binary()],
  optional(:pricing_rule_data) => catalog_pricing_rule(),
  optional(:product_set_data) => catalog_product_set(),
  optional(:quick_amounts_settings_data) => catalog_quick_amounts_settings(),
  optional(:subscription_plan_data) => catalog_subscription_plan(),
  optional(:tax_data) => catalog_tax(),
  optional(:time_period_data) => catalog_time_period(),
  :type => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}
Link to this type

catalog_object_batch()

View Source

Specs

catalog_object_batch() :: %{objects: [catalog_object()]}

Specs

catalog_object_type() :: binary()
Link to this type

catalog_pricing_rule()

View Source

Specs

catalog_pricing_rule() :: %{
  optional(:apply_products_id) => binary(),
  optional(:discount_id) => binary(),
  optional(:exclude_products_id) => binary(),
  optional(:exclude_strategy) => binary(),
  optional(:match_products_id) => binary(),
  optional(:name) => binary(),
  optional(:time_period_ids) => [binary()],
  optional(:valid_from_date) => binary(),
  optional(:valid_from_local_time) => binary(),
  optional(:valid_until_date) => binary(),
  optional(:valid_until_local_time) => binary()
}
Link to this type

catalog_pricing_type()

View Source

Specs

catalog_pricing_type() :: binary()

Specs

catalog_product_set() :: %{
  optional(:all_products) => boolean(),
  optional(:name) => binary(),
  optional(:product_ids_all) => [binary()],
  optional(:product_ids_any) => [binary()],
  optional(:quantity_exact) => integer(),
  optional(:quantity_max) => integer(),
  optional(:quantity_min) => integer()
}

Specs

catalog_query() :: %{
  optional(:exact_query) => catalog_query_exact(),
  optional(:item_variations_for_item_option_values_query) =>
    catalog_query_item_variations_for_item_option_values(),
  optional(:items_for_item_options_query) =>
    catalog_query_items_for_item_options(),
  optional(:items_for_modifier_list_query) =>
    catalog_query_items_for_modifier_list(),
  optional(:items_for_tax_query) => catalog_query_items_for_tax(),
  optional(:prefix_query) => catalog_query_prefix(),
  optional(:range_query) => catalog_query_range(),
  optional(:sorted_attribute_query) => catalog_query_sorted_attribute(),
  optional(:text_query) => catalog_query_text()
}

Specs

catalog_query_exact() :: %{attribute_name: binary(), attribute_value: binary()}
Link to this type

catalog_query_item_variations_for_item_option_values()

View Source

Specs

catalog_query_item_variations_for_item_option_values() :: %{
  optional(:item_option_value_ids) => [binary()]
}
Link to this type

catalog_query_items_for_item_options()

View Source

Specs

catalog_query_items_for_item_options() :: %{
  optional(:item_option_ids) => [binary()]
}
Link to this type

catalog_query_items_for_modifier_list()

View Source

Specs

catalog_query_items_for_modifier_list() :: %{modifier_list_ids: [binary()]}
Link to this type

catalog_query_items_for_tax()

View Source

Specs

catalog_query_items_for_tax() :: %{tax_ids: [binary()]}
Link to this type

catalog_query_prefix()

View Source

Specs

catalog_query_prefix() :: %{
  attribute_name: binary(),
  attribute_prefix: binary()
}

Specs

catalog_query_range() :: %{
  optional(:attribute_max_value) => integer(),
  optional(:attribute_min_value) => integer(),
  :attribute_name => binary()
}
Link to this type

catalog_query_sorted_attribute()

View Source

Specs

catalog_query_sorted_attribute() :: %{
  :attribute_name => binary(),
  optional(:initial_attribute_value) => binary(),
  optional(:sort_order) => binary()
}

Specs

catalog_query_text() :: %{keywords: [binary()]}
Link to this type

catalog_quick_amount()

View Source

Specs

catalog_quick_amount() :: %{
  :amount => money(),
  optional(:ordinal) => integer(),
  optional(:score) => integer(),
  :type => binary()
}
Link to this type

catalog_quick_amount_type()

View Source

Specs

catalog_quick_amount_type() :: binary()
Link to this type

catalog_quick_amounts_settings()

View Source

Specs

catalog_quick_amounts_settings() :: %{
  optional(:amounts) => [catalog_quick_amount()],
  optional(:eligible_for_auto_amounts) => boolean(),
  :option => binary()
}
Link to this type

catalog_quick_amounts_settings_option()

View Source

Specs

catalog_quick_amounts_settings_option() :: binary()
Link to this type

catalog_subscription_plan()

View Source

Specs

catalog_subscription_plan() :: %{
  optional(:name) => binary(),
  optional(:phases) => [subscription_phase()]
}

Specs

catalog_tax() :: %{
  optional(:applies_to_custom_amounts) => boolean(),
  optional(:calculation_phase) => binary(),
  optional(:enabled) => boolean(),
  optional(:inclusion_type) => binary(),
  optional(:name) => binary(),
  optional(:percentage) => binary()
}

Specs

catalog_time_period() :: %{optional(:event) => binary()}

Specs

catalog_v1_id() :: %{
  optional(:catalog_v1_id) => binary(),
  optional(:location_id) => binary()
}

Specs

charge_request() :: %{
  optional(:additional_recipients) => [additional_recipient()],
  :amount_money => money(),
  optional(:billing_address) => address(),
  optional(:buyer_email_address) => binary(),
  optional(:card_nonce) => binary(),
  optional(:customer_card_id) => binary(),
  optional(:customer_id) => binary(),
  optional(:delay_capture) => boolean(),
  :idempotency_key => binary(),
  optional(:note) => binary(),
  optional(:order_id) => binary(),
  optional(:reference_id) => binary(),
  optional(:shipping_address) => address(),
  optional(:verification_token) => binary()
}
Link to this type

charge_request_additional_recipient()

View Source

Specs

charge_request_additional_recipient() :: %{
  amount_money: money(),
  description: binary(),
  location_id: binary()
}

Specs

charge_response() :: %{
  optional(:errors) => [error()],
  optional(:transaction) => transaction()
}

Specs

checkout() :: %{
  optional(:additional_recipients) => [additional_recipient()],
  optional(:ask_for_shipping_address) => boolean(),
  optional(:checkout_page_url) => binary(),
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  optional(:merchant_support_email) => binary(),
  optional(:order) => order(),
  optional(:pre_populate_buyer_email) => binary(),
  optional(:pre_populate_shipping_address) => address(),
  optional(:redirect_url) => binary()
}
Link to this type

complete_payment_request()

View Source

Specs

complete_payment_request() :: %{}
Link to this type

complete_payment_response()

View Source

Specs

complete_payment_response() :: %{
  optional(:errors) => [error()],
  optional(:payment) => payment()
}

Specs

coordinates() :: %{
  optional(:latitude) => number(),
  optional(:longitude) => number()
}

Specs

country() :: binary()
Link to this type

create_break_type_request()

View Source

Specs

create_break_type_request() :: %{
  :break_type => break_type(),
  optional(:idempotency_key) => binary()
}
Link to this type

create_break_type_response()

View Source

Specs

create_break_type_response() :: %{
  optional(:break_type) => break_type(),
  optional(:errors) => [error()]
}
Link to this type

create_catalog_image_request()

View Source

Specs

create_catalog_image_request() :: %{
  :idempotency_key => binary(),
  optional(:image) => catalog_object(),
  optional(:object_id) => binary()
}
Link to this type

create_catalog_image_response()

View Source

Specs

create_catalog_image_response() :: %{
  optional(:errors) => [error()],
  optional(:image) => catalog_object()
}
Link to this type

create_checkout_request()

View Source

Specs

create_checkout_request() :: %{
  optional(:additional_recipients) => [charge_request_additional_recipient()],
  optional(:ask_for_shipping_address) => boolean(),
  :idempotency_key => binary(),
  optional(:merchant_support_email) => binary(),
  optional(:note) => binary(),
  :order => create_order_request(),
  optional(:pre_populate_buyer_email) => binary(),
  optional(:pre_populate_shipping_address) => address(),
  optional(:redirect_url) => binary()
}
Link to this type

create_checkout_response()

View Source

Specs

create_checkout_response() :: %{
  optional(:checkout) => checkout(),
  optional(:errors) => [error()]
}
Link to this type

create_customer_card_request()

View Source

Specs

create_customer_card_request() :: %{
  optional(:billing_address) => address(),
  :card_nonce => binary(),
  optional(:cardholder_name) => binary(),
  optional(:verification_token) => binary()
}
Link to this type

create_customer_card_response()

View Source

Specs

create_customer_card_response() :: %{
  optional(:card) => card(),
  optional(:errors) => [error()]
}
Link to this type

create_customer_group_request()

View Source

Specs

create_customer_group_request() :: %{
  :group => customer_group(),
  optional(:idempotency_key) => binary()
}
Link to this type

create_customer_group_response()

View Source

Specs

create_customer_group_response() :: %{
  optional(:errors) => [error()],
  optional(:group) => customer_group()
}
Link to this type

create_customer_request()

View Source

Specs

create_customer_request() :: %{
  optional(:address) => address(),
  optional(:birthday) => binary(),
  optional(:company_name) => binary(),
  optional(:email_address) => binary(),
  optional(:family_name) => binary(),
  optional(:given_name) => binary(),
  optional(:idempotency_key) => binary(),
  optional(:nickname) => binary(),
  optional(:note) => binary(),
  optional(:phone_number) => binary(),
  optional(:reference_id) => binary()
}
Link to this type

create_customer_response()

View Source

Specs

create_customer_response() :: %{
  optional(:customer) => customer(),
  optional(:errors) => [error()]
}
Link to this type

create_device_code_request()

View Source

Specs

create_device_code_request() :: %{
  device_code: device_code(),
  idempotency_key: binary()
}
Link to this type

create_device_code_response()

View Source

Specs

create_device_code_response() :: %{
  optional(:device_code) => device_code(),
  optional(:errors) => [error()]
}
Link to this type

create_dispute_evidence_file_request()

View Source

Specs

create_dispute_evidence_file_request() :: %{
  optional(:content_type) => binary(),
  optional(:evidence_type) => binary(),
  :idempotency_key => binary()
}
Link to this type

create_dispute_evidence_file_response()

View Source

Specs

create_dispute_evidence_file_response() :: %{
  optional(:errors) => [error()],
  optional(:evidence) => dispute_evidence()
}
Link to this type

create_dispute_evidence_text_request()

View Source

Specs

create_dispute_evidence_text_request() :: %{
  :evidence_text => binary(),
  optional(:evidence_type) => binary(),
  :idempotency_key => binary()
}
Link to this type

create_dispute_evidence_text_response()

View Source

Specs

create_dispute_evidence_text_response() :: %{
  optional(:errors) => [error()],
  optional(:evidence) => dispute_evidence()
}
Link to this type

create_invoice_request()

View Source

Specs

create_invoice_request() :: %{
  optional(:idempotency_key) => binary(),
  :invoice => invoice()
}
Link to this type

create_invoice_response()

View Source

Specs

create_invoice_response() :: %{
  optional(:errors) => [error()],
  optional(:invoice) => invoice()
}
Link to this type

create_location_request()

View Source

Specs

create_location_request() :: %{optional(:location) => location()}
Link to this type

create_location_response()

View Source

Specs

create_location_response() :: %{
  optional(:errors) => [error()],
  optional(:location) => location()
}
Link to this type

create_loyalty_account_request()

View Source

Specs

create_loyalty_account_request() :: %{
  idempotency_key: binary(),
  loyalty_account: loyalty_account()
}
Link to this type

create_loyalty_account_response()

View Source

Specs

create_loyalty_account_response() :: %{
  optional(:errors) => [error()],
  optional(:loyalty_account) => loyalty_account()
}
Link to this type

create_loyalty_reward_request()

View Source

Specs

create_loyalty_reward_request() :: %{
  idempotency_key: binary(),
  reward: loyalty_reward()
}
Link to this type

create_loyalty_reward_response()

View Source

Specs

create_loyalty_reward_response() :: %{
  optional(:errors) => [error()],
  optional(:reward) => loyalty_reward()
}
Link to this type

create_mobile_authorization_code_request()

View Source

Specs

create_mobile_authorization_code_request() :: %{
  optional(:location_id) => binary()
}
Link to this type

create_mobile_authorization_code_response()

View Source

Specs

create_mobile_authorization_code_response() :: %{
  optional(:authorization_code) => binary(),
  optional(:error) => error(),
  optional(:expires_at) => binary()
}
Link to this type

create_order_request()

View Source

Specs

create_order_request() :: %{
  optional(:idempotency_key) => binary(),
  optional(:location_id) => binary(),
  optional(:order) => order()
}
Link to this type

create_order_response()

View Source

Specs

create_order_response() :: %{
  optional(:errors) => [error()],
  optional(:order) => order()
}
Link to this type

create_payment_request()

View Source

Specs

create_payment_request() :: %{
  optional(:accept_partial_authorization) => boolean(),
  :amount_money => money(),
  optional(:app_fee_money) => money(),
  optional(:autocomplete) => boolean(),
  optional(:billing_address) => address(),
  optional(:buyer_email_address) => binary(),
  optional(:customer_id) => binary(),
  optional(:delay_duration) => binary(),
  :idempotency_key => binary(),
  optional(:location_id) => binary(),
  optional(:note) => binary(),
  optional(:order_id) => binary(),
  optional(:reference_id) => binary(),
  optional(:shipping_address) => address(),
  :source_id => binary(),
  optional(:statement_description_identifier) => binary(),
  optional(:tip_money) => money(),
  optional(:verification_token) => binary()
}
Link to this type

create_payment_response()

View Source

Specs

create_payment_response() :: %{
  optional(:errors) => [error()],
  optional(:payment) => payment()
}
Link to this type

create_refund_request()

View Source

Specs

create_refund_request() :: %{
  :amount_money => money(),
  :idempotency_key => binary(),
  optional(:reason) => binary(),
  :tender_id => binary()
}
Link to this type

create_refund_response()

View Source

Specs

create_refund_response() :: %{
  optional(:errors) => [error()],
  optional(:refund) => refund()
}
Link to this type

create_shift_request()

View Source

Specs

create_shift_request() :: %{
  optional(:idempotency_key) => binary(),
  :shift => shift()
}
Link to this type

create_shift_response()

View Source

Specs

create_shift_response() :: %{
  optional(:errors) => [error()],
  optional(:shift) => shift()
}
Link to this type

create_subscription_request()

View Source

Specs

create_subscription_request() :: %{
  optional(:canceled_date) => binary(),
  optional(:card_id) => binary(),
  :customer_id => binary(),
  :idempotency_key => binary(),
  :location_id => binary(),
  :plan_id => binary(),
  optional(:price_override_money) => money(),
  optional(:start_date) => binary(),
  optional(:tax_percentage) => binary(),
  optional(:timezone) => binary()
}
Link to this type

create_subscription_response()

View Source

Specs

create_subscription_response() :: %{
  optional(:errors) => [error()],
  optional(:subscription) => subscription()
}
Link to this type

create_team_member_request()

View Source

Specs

create_team_member_request() :: %{
  optional(:idempotency_key) => binary(),
  optional(:team_member) => team_member()
}
Link to this type

create_team_member_response()

View Source

Specs

create_team_member_response() :: %{
  optional(:errors) => [error()],
  optional(:team_member) => team_member()
}
Link to this type

create_terminal_checkout_request()

View Source

Specs

create_terminal_checkout_request() :: %{
  checkout: terminal_checkout(),
  idempotency_key: binary()
}
Link to this type

create_terminal_checkout_response()

View Source

Specs

create_terminal_checkout_response() :: %{
  optional(:checkout) => terminal_checkout(),
  optional(:errors) => [error()]
}

Specs

currency() :: binary()
Link to this type

custom_attribute_filter()

View Source

Specs

custom_attribute_filter() :: %{
  optional(:bool_filter) => boolean(),
  optional(:custom_attribute_definition_id) => binary(),
  optional(:key) => binary(),
  optional(:number_filter) => range(),
  optional(:selection_uids_filter) => [binary()],
  optional(:string_filter) => binary()
}

Specs

customer() :: %{
  optional(:address) => address(),
  optional(:birthday) => binary(),
  optional(:cards) => [card()],
  optional(:company_name) => binary(),
  optional(:created_at) => binary(),
  optional(:creation_source) => binary(),
  optional(:email_address) => binary(),
  optional(:family_name) => binary(),
  optional(:given_name) => binary(),
  optional(:group_ids) => [binary()],
  optional(:groups) => [customer_group_info()],
  optional(:id) => binary(),
  optional(:nickname) => binary(),
  optional(:note) => binary(),
  optional(:phone_number) => binary(),
  optional(:preferences) => customer_preferences(),
  optional(:reference_id) => binary(),
  optional(:segment_ids) => [binary()],
  optional(:updated_at) => binary()
}
Link to this type

customer_creation_source()

View Source

Specs

customer_creation_source() :: binary()
Link to this type

customer_creation_source_filter()

View Source

Specs

customer_creation_source_filter() :: %{
  optional(:rule) => binary(),
  optional(:values) => [binary()]
}

Specs

customer_filter() :: %{
  optional(:created_at) => time_range(),
  optional(:creation_source) => customer_creation_source_filter(),
  optional(:email_address) => customer_text_filter(),
  optional(:group_ids) => filter_value(),
  optional(:phone_number) => customer_text_filter(),
  optional(:reference_id) => customer_text_filter(),
  optional(:updated_at) => time_range()
}

Specs

customer_group() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  :name => binary(),
  optional(:updated_at) => binary()
}

Specs

customer_group_info() :: %{id: binary(), name: binary()}
Link to this type

customer_inclusion_exclusion()

View Source

Specs

customer_inclusion_exclusion() :: binary()
Link to this type

customer_preferences()

View Source

Specs

customer_preferences() :: %{optional(:email_unsubscribed) => boolean()}

Specs

customer_query() :: %{
  optional(:filter) => customer_filter(),
  optional(:sort) => customer_sort()
}

Specs

customer_segment() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  :name => binary(),
  optional(:updated_at) => binary()
}

Specs

customer_sort() :: %{optional(:field) => binary(), optional(:order) => binary()}

Specs

customer_sort_field() :: binary()
Link to this type

customer_text_filter()

View Source

Specs

customer_text_filter() :: %{
  optional(:exact) => binary(),
  optional(:fuzzy) => binary()
}

Specs

date_range() :: %{
  optional(:end_date) => binary(),
  optional(:start_date) => binary()
}

Specs

day_of_week() :: binary()
Link to this type

delete_break_type_request()

View Source

Specs

delete_break_type_request() :: %{}
Link to this type

delete_break_type_response()

View Source

Specs

delete_break_type_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_catalog_object_request()

View Source

Specs

delete_catalog_object_request() :: %{}
Link to this type

delete_catalog_object_response()

View Source

Specs

delete_catalog_object_response() :: %{
  optional(:deleted_at) => binary(),
  optional(:deleted_object_ids) => [binary()],
  optional(:errors) => [error()]
}
Link to this type

delete_customer_card_request()

View Source

Specs

delete_customer_card_request() :: %{}
Link to this type

delete_customer_card_response()

View Source

Specs

delete_customer_card_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_customer_group_request()

View Source

Specs

delete_customer_group_request() :: %{}
Link to this type

delete_customer_group_response()

View Source

Specs

delete_customer_group_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_customer_request()

View Source

Specs

delete_customer_request() :: %{}
Link to this type

delete_customer_response()

View Source

Specs

delete_customer_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_invoice_request()

View Source

Specs

delete_invoice_request() :: %{optional(:version) => integer()}
Link to this type

delete_invoice_response()

View Source

Specs

delete_invoice_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_loyalty_reward_request()

View Source

Specs

delete_loyalty_reward_request() :: %{}
Link to this type

delete_loyalty_reward_response()

View Source

Specs

delete_loyalty_reward_response() :: %{optional(:errors) => [error()]}
Link to this type

delete_shift_request()

View Source

Specs

delete_shift_request() :: %{}
Link to this type

delete_shift_response()

View Source

Specs

delete_shift_response() :: %{optional(:errors) => [error()]}

Specs

device() :: %{optional(:id) => binary(), optional(:name) => binary()}
Link to this type

device_checkout_options()

View Source

Specs

device_checkout_options() :: %{
  :device_id => binary(),
  optional(:skip_receipt_screen) => boolean(),
  optional(:tip_settings) => tip_settings()
}

Specs

device_code() :: %{
  optional(:code) => binary(),
  optional(:created_at) => binary(),
  optional(:device_id) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:name) => binary(),
  optional(:pair_by) => binary(),
  optional(:paired_at) => binary(),
  :product_type => binary(),
  optional(:status) => binary(),
  optional(:status_changed_at) => binary()
}

Specs

device_code_status() :: binary()

Specs

device_details() :: %{
  optional(:device_id) => binary(),
  optional(:device_name) => binary()
}

Specs

dispute() :: %{
  optional(:amount_money) => money(),
  optional(:brand_dispute_id) => binary(),
  optional(:card_brand) => binary(),
  optional(:created_at) => binary(),
  optional(:dispute_id) => binary(),
  optional(:disputed_payment) => disputed_payment(),
  optional(:due_at) => binary(),
  optional(:evidence_ids) => [binary()],
  optional(:location_id) => binary(),
  optional(:reason) => binary(),
  optional(:reported_date) => binary(),
  optional(:state) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}

Specs

dispute_evidence() :: %{
  optional(:dispute_id) => binary(),
  optional(:evidence_id) => binary(),
  optional(:evidence_type) => binary(),
  optional(:uploaded_at) => binary()
}
Link to this type

dispute_evidence_file()

View Source

Specs

dispute_evidence_file() :: %{
  optional(:filename) => binary(),
  optional(:filetype) => binary()
}
Link to this type

dispute_evidence_type()

View Source

Specs

dispute_evidence_type() :: binary()

Specs

dispute_reason() :: binary()

Specs

dispute_state() :: binary()

Specs

disputed_payment() :: %{optional(:payment_id) => binary()}

Specs

ecom_visibility() :: binary()

Specs

employee() :: %{
  optional(:created_at) => binary(),
  optional(:email) => binary(),
  optional(:first_name) => binary(),
  optional(:id) => binary(),
  optional(:is_owner) => boolean(),
  optional(:last_name) => binary(),
  optional(:location_ids) => [binary()],
  optional(:phone_number) => binary(),
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}

Specs

employee_status() :: binary()

Specs

employee_wage() :: %{
  optional(:employee_id) => binary(),
  optional(:hourly_rate) => money(),
  optional(:id) => binary(),
  optional(:title) => binary()
}

Specs

error() :: %{
  :category => binary(),
  :code => binary(),
  optional(:detail) => binary(),
  optional(:field) => binary()
}

Specs

error_category() :: binary()

Specs

error_code() :: binary()

Specs

exclude_strategy() :: binary()

Specs

filter_value() :: %{
  optional(:all) => [binary()],
  optional(:any) => [binary()],
  optional(:none) => [binary()]
}
Link to this type

get_bank_account_by_v1_id_request()

View Source

Specs

get_bank_account_by_v1_id_request() :: %{}
Link to this type

get_bank_account_by_v1_id_response()

View Source

Specs

get_bank_account_by_v1_id_response() :: %{
  optional(:bank_account) => bank_account(),
  optional(:errors) => [error()]
}
Link to this type

get_bank_account_request()

View Source

Specs

get_bank_account_request() :: %{}
Link to this type

get_bank_account_response()

View Source

Specs

get_bank_account_response() :: %{
  optional(:bank_account) => bank_account(),
  optional(:errors) => [error()]
}
Link to this type

get_break_type_request()

View Source

Specs

get_break_type_request() :: %{}
Link to this type

get_break_type_response()

View Source

Specs

get_break_type_response() :: %{
  optional(:break_type) => break_type(),
  optional(:errors) => [error()]
}
Link to this type

get_device_code_request()

View Source

Specs

get_device_code_request() :: %{}
Link to this type

get_device_code_response()

View Source

Specs

get_device_code_response() :: %{
  optional(:device_code) => device_code(),
  optional(:errors) => [error()]
}
Link to this type

get_employee_wage_request()

View Source

Specs

get_employee_wage_request() :: %{}
Link to this type

get_employee_wage_response()

View Source

Specs

get_employee_wage_response() :: %{
  optional(:employee_wage) => employee_wage(),
  optional(:errors) => [error()]
}

Specs

get_invoice_request() :: %{}
Link to this type

get_invoice_response()

View Source

Specs

get_invoice_response() :: %{
  optional(:errors) => [error()],
  optional(:invoice) => invoice()
}
Link to this type

get_payment_refund_request()

View Source

Specs

get_payment_refund_request() :: %{}
Link to this type

get_payment_refund_response()

View Source

Specs

get_payment_refund_response() :: %{
  optional(:errors) => [error()],
  optional(:refund) => payment_refund()
}

Specs

get_payment_request() :: %{}
Link to this type

get_payment_response()

View Source

Specs

get_payment_response() :: %{
  optional(:errors) => [error()],
  optional(:payment) => payment()
}

Specs

get_shift_request() :: %{}

Specs

get_shift_response() :: %{
  optional(:errors) => [error()],
  optional(:shift) => shift()
}
Link to this type

get_team_member_wage_request()

View Source

Specs

get_team_member_wage_request() :: %{}
Link to this type

get_team_member_wage_response()

View Source

Specs

get_team_member_wage_response() :: %{
  optional(:errors) => [error()],
  optional(:team_member_wage) => team_member_wage()
}
Link to this type

get_terminal_checkout_request()

View Source

Specs

get_terminal_checkout_request() :: %{}
Link to this type

get_terminal_checkout_response()

View Source

Specs

get_terminal_checkout_response() :: %{
  optional(:checkout) => terminal_checkout(),
  optional(:errors) => [error()]
}
Link to this type

inventory_adjustment()

View Source

Specs

inventory_adjustment() :: %{
  optional(:catalog_object_id) => binary(),
  optional(:catalog_object_type) => binary(),
  optional(:created_at) => binary(),
  optional(:employee_id) => binary(),
  optional(:from_state) => binary(),
  optional(:goods_receipt_id) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:occurred_at) => binary(),
  optional(:purchase_order_id) => binary(),
  optional(:quantity) => binary(),
  optional(:reference_id) => binary(),
  optional(:refund_id) => binary(),
  optional(:source) => source_application(),
  optional(:to_state) => binary(),
  optional(:total_price_money) => money(),
  optional(:transaction_id) => binary()
}
Link to this type

inventory_alert_type()

View Source

Specs

inventory_alert_type() :: binary()

Specs

inventory_change() :: %{
  optional(:adjustment) => inventory_adjustment(),
  optional(:physical_count) => inventory_physical_count(),
  optional(:transfer) => inventory_transfer(),
  optional(:type) => binary()
}
Link to this type

inventory_change_type()

View Source

Specs

inventory_change_type() :: binary()

Specs

inventory_count() :: %{
  optional(:calculated_at) => binary(),
  optional(:catalog_object_id) => binary(),
  optional(:catalog_object_type) => binary(),
  optional(:location_id) => binary(),
  optional(:quantity) => binary(),
  optional(:state) => binary()
}
Link to this type

inventory_physical_count()

View Source

Specs

inventory_physical_count() :: %{
  optional(:catalog_object_id) => binary(),
  optional(:catalog_object_type) => binary(),
  optional(:created_at) => binary(),
  optional(:employee_id) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:occurred_at) => binary(),
  optional(:quantity) => binary(),
  optional(:reference_id) => binary(),
  optional(:source) => source_application(),
  optional(:state) => binary()
}

Specs

inventory_state() :: binary()

Specs

inventory_transfer() :: %{
  optional(:catalog_object_id) => binary(),
  optional(:catalog_object_type) => binary(),
  optional(:created_at) => binary(),
  optional(:employee_id) => binary(),
  optional(:from_location_id) => binary(),
  optional(:id) => binary(),
  optional(:occurred_at) => binary(),
  optional(:quantity) => binary(),
  optional(:reference_id) => binary(),
  optional(:source) => source_application(),
  optional(:state) => binary(),
  optional(:to_location_id) => binary()
}

Specs

invoice() :: %{
  optional(:created_at) => binary(),
  optional(:description) => binary(),
  optional(:id) => binary(),
  optional(:invoice_number) => binary(),
  optional(:location_id) => binary(),
  optional(:next_payment_amount_money) => money(),
  optional(:order_id) => binary(),
  optional(:payment_requests) => [invoice_payment_request()],
  optional(:primary_recipient) => invoice_recipient(),
  optional(:public_url) => binary(),
  optional(:scheduled_at) => binary(),
  optional(:status) => binary(),
  optional(:timezone) => binary(),
  optional(:title) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}

Specs

invoice_filter() :: %{
  optional(:customer_ids) => [binary()],
  :location_ids => [binary()]
}
Link to this type

invoice_payment_reminder()

View Source

Specs

invoice_payment_reminder() :: %{
  optional(:message) => binary(),
  optional(:relative_scheduled_days) => integer(),
  optional(:sent_at) => binary(),
  optional(:status) => binary(),
  optional(:uid) => binary()
}
Link to this type

invoice_payment_reminder_status()

View Source

Specs

invoice_payment_reminder_status() :: binary()
Link to this type

invoice_payment_request()

View Source

Specs

invoice_payment_request() :: %{
  optional(:card_id) => binary(),
  optional(:computed_amount_money) => money(),
  optional(:due_date) => binary(),
  optional(:fixed_amount_requested_money) => money(),
  optional(:percentage_requested) => binary(),
  optional(:reminders) => [invoice_payment_reminder()],
  optional(:request_method) => binary(),
  optional(:request_type) => binary(),
  optional(:rounding_adjustment_included_money) => money(),
  optional(:tipping_enabled) => boolean(),
  optional(:total_completed_amount_money) => money(),
  optional(:uid) => binary()
}

Specs

invoice_query() :: %{
  :filter => invoice_filter(),
  optional(:sort) => invoice_sort()
}

Specs

invoice_recipient() :: %{
  optional(:address) => address(),
  optional(:company_name) => binary(),
  optional(:customer_id) => binary(),
  optional(:email_address) => binary(),
  optional(:family_name) => binary(),
  optional(:given_name) => binary(),
  optional(:phone_number) => binary()
}
Link to this type

invoice_request_method()

View Source

Specs

invoice_request_method() :: binary()
Link to this type

invoice_request_type()

View Source

Specs

invoice_request_type() :: binary()

Specs

invoice_sort() :: %{:field => binary(), optional(:order) => binary()}

Specs

invoice_sort_field() :: binary()

Specs

invoice_status() :: binary()
Link to this type

item_variation_location_overrides()

View Source

Specs

item_variation_location_overrides() :: %{
  optional(:inventory_alert_threshold) => integer(),
  optional(:inventory_alert_type) => binary(),
  optional(:location_id) => binary(),
  optional(:price_money) => money(),
  optional(:pricing_type) => binary(),
  optional(:track_inventory) => boolean()
}

Specs

job_assignment() :: %{
  optional(:annual_rate) => money(),
  optional(:hourly_rate) => money(),
  :job_title => binary(),
  :pay_type => binary(),
  optional(:weekly_hours) => integer()
}
Link to this type

job_assignment_pay_type()

View Source

Specs

job_assignment_pay_type() :: binary()
Link to this type

list_bank_accounts_request()

View Source

Specs

list_bank_accounts_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:location_id) => binary()
}
Link to this type

list_bank_accounts_response()

View Source

Specs

list_bank_accounts_response() :: %{
  optional(:bank_accounts) => [bank_account()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

list_break_types_request()

View Source

Specs

list_break_types_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:location_id) => binary()
}
Link to this type

list_break_types_response()

View Source

Specs

list_break_types_response() :: %{
  optional(:break_types) => [break_type()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

list_cash_drawer_shift_events_request()

View Source

Specs

list_cash_drawer_shift_events_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  :location_id => binary()
}
Link to this type

list_cash_drawer_shift_events_response()

View Source

Specs

list_cash_drawer_shift_events_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:events) => [cash_drawer_shift_event()]
}
Link to this type

list_cash_drawer_shifts_request()

View Source

Specs

list_cash_drawer_shifts_request() :: %{
  optional(:begin_time) => binary(),
  optional(:cursor) => binary(),
  optional(:end_time) => binary(),
  optional(:limit) => integer(),
  :location_id => binary(),
  optional(:sort_order) => binary()
}
Link to this type

list_cash_drawer_shifts_response()

View Source

Specs

list_cash_drawer_shifts_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:items) => [cash_drawer_shift_summary()]
}
Link to this type

list_catalog_request()

View Source

Specs

list_catalog_request() :: %{
  optional(:cursor) => binary(),
  optional(:types) => binary()
}
Link to this type

list_catalog_response()

View Source

Specs

list_catalog_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:objects) => [catalog_object()]
}
Link to this type

list_customer_groups_request()

View Source

Specs

list_customer_groups_request() :: %{optional(:cursor) => binary()}
Link to this type

list_customer_groups_response()

View Source

Specs

list_customer_groups_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:groups) => [customer_group()]
}
Link to this type

list_customer_segments_request()

View Source

Specs

list_customer_segments_request() :: %{optional(:cursor) => binary()}
Link to this type

list_customer_segments_response()

View Source

Specs

list_customer_segments_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:segments) => [customer_segment()]
}
Link to this type

list_customers_request()

View Source

Specs

list_customers_request() :: %{
  optional(:cursor) => binary(),
  optional(:sort_field) => binary(),
  optional(:sort_order) => binary()
}
Link to this type

list_customers_response()

View Source

Specs

list_customers_response() :: %{
  optional(:cursor) => binary(),
  optional(:customers) => [customer()],
  optional(:errors) => [error()]
}
Link to this type

list_device_codes_request()

View Source

Specs

list_device_codes_request() :: %{
  optional(:cursor) => binary(),
  optional(:location_id) => binary(),
  optional(:product_type) => binary()
}
Link to this type

list_device_codes_response()

View Source

Specs

list_device_codes_response() :: %{
  optional(:cursor) => binary(),
  optional(:device_codes) => [device_code()],
  optional(:errors) => [error()]
}
Link to this type

list_dispute_evidence_request()

View Source

Specs

list_dispute_evidence_request() :: %{}
Link to this type

list_dispute_evidence_response()

View Source

Specs

list_dispute_evidence_response() :: %{
  optional(:errors) => [error()],
  optional(:evidence) => [dispute_evidence()]
}
Link to this type

list_disputes_request()

View Source

Specs

list_disputes_request() :: %{
  optional(:cursor) => binary(),
  optional(:location_id) => binary(),
  optional(:states) => [binary()]
}
Link to this type

list_disputes_response()

View Source

Specs

list_disputes_response() :: %{
  optional(:cursor) => binary(),
  optional(:disputes) => [dispute()],
  optional(:errors) => [error()]
}
Link to this type

list_employee_wages_request()

View Source

Specs

list_employee_wages_request() :: %{
  optional(:cursor) => binary(),
  optional(:employee_id) => binary(),
  optional(:limit) => integer()
}
Link to this type

list_employee_wages_response()

View Source

Specs

list_employee_wages_response() :: %{
  optional(:cursor) => binary(),
  optional(:employee_wages) => [employee_wage()],
  optional(:errors) => [error()]
}
Link to this type

list_employees_request()

View Source

Specs

list_employees_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:location_id) => binary(),
  optional(:status) => binary()
}
Link to this type

list_employees_response()

View Source

Specs

list_employees_response() :: %{
  optional(:cursor) => binary(),
  optional(:employees) => [employee()],
  optional(:errors) => [error()]
}
Link to this type

list_invoices_request()

View Source

Specs

list_invoices_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  :location_id => binary()
}
Link to this type

list_invoices_response()

View Source

Specs

list_invoices_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:invoices) => [invoice()]
}
Link to this type

list_locations_request()

View Source

Specs

list_locations_request() :: %{}
Link to this type

list_locations_response()

View Source

Specs

list_locations_response() :: %{
  optional(:errors) => [error()],
  optional(:locations) => [location()]
}
Link to this type

list_loyalty_programs_request()

View Source

Specs

list_loyalty_programs_request() :: %{}
Link to this type

list_loyalty_programs_response()

View Source

Specs

list_loyalty_programs_response() :: %{
  optional(:errors) => [error()],
  optional(:programs) => [loyalty_program()]
}
Link to this type

list_merchants_request()

View Source

Specs

list_merchants_request() :: %{optional(:cursor) => integer()}
Link to this type

list_merchants_response()

View Source

Specs

list_merchants_response() :: %{
  optional(:cursor) => integer(),
  optional(:errors) => [error()],
  optional(:merchant) => [merchant()]
}
Link to this type

list_payment_refunds_request()

View Source

Specs

list_payment_refunds_request() :: %{
  optional(:begin_time) => binary(),
  optional(:cursor) => binary(),
  optional(:end_time) => binary(),
  optional(:location_id) => binary(),
  optional(:sort_order) => binary(),
  optional(:source_type) => binary(),
  optional(:status) => binary()
}
Link to this type

list_payment_refunds_response()

View Source

Specs

list_payment_refunds_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:refunds) => [payment_refund()]
}
Link to this type

list_payments_request()

View Source

Specs

list_payments_request() :: %{
  optional(:begin_time) => binary(),
  optional(:card_brand) => binary(),
  optional(:cursor) => binary(),
  optional(:end_time) => binary(),
  optional(:last_4) => binary(),
  optional(:location_id) => binary(),
  optional(:sort_order) => binary(),
  optional(:total) => integer()
}
Link to this type

list_payments_response()

View Source

Specs

list_payments_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:payments) => [payment()]
}
Link to this type

list_refunds_request()

View Source

Specs

list_refunds_request() :: %{
  optional(:begin_time) => binary(),
  optional(:cursor) => binary(),
  optional(:end_time) => binary(),
  optional(:sort_order) => binary()
}
Link to this type

list_refunds_response()

View Source

Specs

list_refunds_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:refunds) => [refund()]
}
Link to this type

list_subscription_events_request()

View Source

Specs

list_subscription_events_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer()
}
Link to this type

list_subscription_events_response()

View Source

Specs

list_subscription_events_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:subscription_events) => [subscription_event()]
}
Link to this type

list_team_member_wages_request()

View Source

Specs

list_team_member_wages_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:team_member_id) => binary()
}
Link to this type

list_team_member_wages_response()

View Source

Specs

list_team_member_wages_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:team_member_wages) => [team_member_wage()]
}
Link to this type

list_transactions_request()

View Source

Specs

list_transactions_request() :: %{
  optional(:begin_time) => binary(),
  optional(:cursor) => binary(),
  optional(:end_time) => binary(),
  optional(:sort_order) => binary()
}
Link to this type

list_transactions_response()

View Source

Specs

list_transactions_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:transactions) => [transaction()]
}
Link to this type

list_workweek_configs_request()

View Source

Specs

list_workweek_configs_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer()
}
Link to this type

list_workweek_configs_response()

View Source

Specs

list_workweek_configs_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:workweek_configs) => [workweek_config()]
}

Specs

location() :: %{
  optional(:address) => address(),
  optional(:business_email) => binary(),
  optional(:business_hours) => business_hours(),
  optional(:business_name) => binary(),
  optional(:capabilities) => [binary()],
  optional(:coordinates) => coordinates(),
  optional(:country) => binary(),
  optional(:created_at) => binary(),
  optional(:currency) => binary(),
  optional(:description) => binary(),
  optional(:facebook_url) => binary(),
  optional(:id) => binary(),
  optional(:instagram_username) => binary(),
  optional(:language_code) => binary(),
  optional(:logo_url) => binary(),
  optional(:mcc) => binary(),
  optional(:merchant_id) => binary(),
  optional(:name) => binary(),
  optional(:phone_number) => binary(),
  optional(:pos_background_url) => binary(),
  optional(:status) => binary(),
  optional(:timezone) => binary(),
  optional(:twitter_username) => binary(),
  optional(:type) => binary(),
  optional(:website_url) => binary()
}

Specs

location_capability() :: binary()

Specs

location_status() :: binary()

Specs

location_type() :: binary()

Specs

loyalty_account() :: %{
  optional(:balance) => integer(),
  optional(:created_at) => binary(),
  optional(:customer_id) => binary(),
  optional(:enrolled_at) => binary(),
  optional(:id) => binary(),
  optional(:lifetime_points) => integer(),
  :mappings => [loyalty_account_mapping()],
  :program_id => binary(),
  optional(:updated_at) => binary()
}
Link to this type

loyalty_account_mapping()

View Source

Specs

loyalty_account_mapping() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  :type => binary(),
  :value => binary()
}
Link to this type

loyalty_account_mapping_type()

View Source

Specs

loyalty_account_mapping_type() :: binary()

Specs

loyalty_event() :: %{
  optional(:accumulate_points) => loyalty_event_accumulate_points(),
  optional(:adjust_points) => loyalty_event_adjust_points(),
  optional(:create_reward) => loyalty_event_create_reward(),
  :created_at => binary(),
  optional(:delete_reward) => loyalty_event_delete_reward(),
  optional(:expire_points) => loyalty_event_expire_points(),
  :id => binary(),
  optional(:location_id) => binary(),
  :loyalty_account_id => binary(),
  optional(:other_event) => loyalty_event_other(),
  optional(:redeem_reward) => loyalty_event_redeem_reward(),
  :source => binary(),
  :type => binary()
}
Link to this type

loyalty_event_accumulate_points()

View Source

Specs

loyalty_event_accumulate_points() :: %{
  optional(:loyalty_program_id) => binary(),
  optional(:order_id) => binary(),
  optional(:points) => integer()
}
Link to this type

loyalty_event_adjust_points()

View Source

Specs

loyalty_event_adjust_points() :: %{
  optional(:loyalty_program_id) => binary(),
  :points => integer(),
  optional(:reason) => binary()
}
Link to this type

loyalty_event_create_reward()

View Source

Specs

loyalty_event_create_reward() :: %{
  :loyalty_program_id => binary(),
  :points => integer(),
  optional(:reward_id) => binary()
}
Link to this type

loyalty_event_date_time_filter()

View Source

Specs

loyalty_event_date_time_filter() :: %{created_at: time_range()}
Link to this type

loyalty_event_delete_reward()

View Source

Specs

loyalty_event_delete_reward() :: %{
  :loyalty_program_id => binary(),
  :points => integer(),
  optional(:reward_id) => binary()
}
Link to this type

loyalty_event_expire_points()

View Source

Specs

loyalty_event_expire_points() :: %{
  loyalty_program_id: binary(),
  points: integer()
}
Link to this type

loyalty_event_filter()

View Source

Specs

loyalty_event_filter() :: %{
  optional(:date_time_filter) => loyalty_event_date_time_filter(),
  optional(:location_filter) => loyalty_event_location_filter(),
  optional(:loyalty_account_filter) => loyalty_event_loyalty_account_filter(),
  optional(:order_filter) => loyalty_event_order_filter(),
  optional(:type_filter) => loyalty_event_type_filter()
}
Link to this type

loyalty_event_location_filter()

View Source

Specs

loyalty_event_location_filter() :: %{location_ids: [binary()]}
Link to this type

loyalty_event_loyalty_account_filter()

View Source

Specs

loyalty_event_loyalty_account_filter() :: %{loyalty_account_id: binary()}
Link to this type

loyalty_event_order_filter()

View Source

Specs

loyalty_event_order_filter() :: %{order_id: binary()}

Specs

loyalty_event_other() :: %{loyalty_program_id: binary(), points: integer()}

Specs

loyalty_event_query() :: %{optional(:filter) => loyalty_event_filter()}
Link to this type

loyalty_event_redeem_reward()

View Source

Specs

loyalty_event_redeem_reward() :: %{
  :loyalty_program_id => binary(),
  optional(:order_id) => binary(),
  optional(:reward_id) => binary()
}
Link to this type

loyalty_event_source()

View Source

Specs

loyalty_event_source() :: binary()

Specs

loyalty_event_type() :: binary()
Link to this type

loyalty_event_type_filter()

View Source

Specs

loyalty_event_type_filter() :: %{types: [binary()]}

Specs

loyalty_program() :: %{
  :accrual_rules => [loyalty_program_accrual_rule()],
  :created_at => binary(),
  optional(:expiration_policy) => loyalty_program_expiration_policy(),
  :id => binary(),
  :location_ids => [binary()],
  :reward_tiers => [loyalty_program_reward_tier()],
  :status => binary(),
  :terminology => loyalty_program_terminology(),
  :updated_at => binary()
}
Link to this type

loyalty_program_accrual_rule()

View Source

Specs

loyalty_program_accrual_rule() :: %{
  :accrual_type => binary(),
  optional(:catalog_object_id) => binary(),
  optional(:points) => integer(),
  optional(:spend_amount_money) => money(),
  optional(:visit_minimum_amount_money) => money()
}
Link to this type

loyalty_program_accrual_rule_type()

View Source

Specs

loyalty_program_accrual_rule_type() :: binary()
Link to this type

loyalty_program_expiration_policy()

View Source

Specs

loyalty_program_expiration_policy() :: %{expiration_duration: binary()}
Link to this type

loyalty_program_reward_definition()

View Source

Specs

loyalty_program_reward_definition() :: %{
  optional(:catalog_object_ids) => [binary()],
  :discount_type => binary(),
  optional(:fixed_discount_money) => money(),
  optional(:max_discount_money) => money(),
  optional(:percentage_discount) => binary(),
  :scope => binary()
}
Link to this type

loyalty_program_reward_definition_scope()

View Source

Specs

loyalty_program_reward_definition_scope() :: binary()
Link to this type

loyalty_program_reward_definition_type()

View Source

Specs

loyalty_program_reward_definition_type() :: binary()
Link to this type

loyalty_program_reward_tier()

View Source

Specs

loyalty_program_reward_tier() :: %{
  created_at: binary(),
  definition: loyalty_program_reward_definition(),
  id: binary(),
  name: binary(),
  points: integer()
}
Link to this type

loyalty_program_status()

View Source

Specs

loyalty_program_status() :: binary()
Link to this type

loyalty_program_terminology()

View Source

Specs

loyalty_program_terminology() :: %{one: binary(), other: binary()}

Specs

loyalty_reward() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  :loyalty_account_id => binary(),
  optional(:order_id) => binary(),
  optional(:points) => integer(),
  optional(:redeemed_at) => binary(),
  :reward_tier_id => binary(),
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}
Link to this type

loyalty_reward_status()

View Source

Specs

loyalty_reward_status() :: binary()

Specs

measurement_unit() :: %{
  optional(:area_unit) => binary(),
  optional(:custom_unit) => measurement_unit_custom(),
  optional(:generic_unit) => binary(),
  optional(:length_unit) => binary(),
  optional(:time_unit) => binary(),
  optional(:type) => binary(),
  optional(:volume_unit) => binary(),
  optional(:weight_unit) => binary()
}
Link to this type

measurement_unit_area()

View Source

Specs

measurement_unit_area() :: binary()
Link to this type

measurement_unit_custom()

View Source

Specs

measurement_unit_custom() :: %{abbreviation: binary(), name: binary()}
Link to this type

measurement_unit_generic()

View Source

Specs

measurement_unit_generic() :: binary()
Link to this type

measurement_unit_length()

View Source

Specs

measurement_unit_length() :: binary()
Link to this type

measurement_unit_time()

View Source

Specs

measurement_unit_time() :: binary()
Link to this type

measurement_unit_unit_type()

View Source

Specs

measurement_unit_unit_type() :: binary()
Link to this type

measurement_unit_volume()

View Source

Specs

measurement_unit_volume() :: binary()
Link to this type

measurement_unit_weight()

View Source

Specs

measurement_unit_weight() :: binary()

Specs

merchant() :: %{
  optional(:business_name) => binary(),
  :country => binary(),
  optional(:currency) => binary(),
  optional(:id) => binary(),
  optional(:language_code) => binary(),
  optional(:main_location_id) => binary(),
  optional(:status) => binary()
}

Specs

merchant_status() :: binary()

Specs

money() :: %{optional(:amount) => integer(), optional(:currency) => binary()}
Link to this type

obtain_token_request()

View Source

Specs

obtain_token_request() :: %{
  :client_id => binary(),
  :client_secret => binary(),
  optional(:code) => binary(),
  :grant_type => binary(),
  optional(:migration_token) => binary(),
  optional(:redirect_uri) => binary(),
  optional(:refresh_token) => binary()
}
Link to this type

obtain_token_response()

View Source

Specs

obtain_token_response() :: %{
  optional(:access_token) => binary(),
  optional(:expires_at) => binary(),
  optional(:id_token) => binary(),
  optional(:merchant_id) => binary(),
  optional(:plan_id) => binary(),
  optional(:refresh_token) => binary(),
  optional(:subscription_id) => binary(),
  optional(:token_type) => binary()
}

Specs

order() :: %{
  optional(:closed_at) => binary(),
  optional(:created_at) => binary(),
  optional(:customer_id) => binary(),
  optional(:discounts) => [order_line_item_discount()],
  optional(:fulfillments) => [order_fulfillment()],
  optional(:id) => binary(),
  optional(:line_items) => [order_line_item()],
  :location_id => binary(),
  optional(:metadata) => map(),
  optional(:net_amounts) => order_money_amounts(),
  optional(:pricing_options) => order_pricing_options(),
  optional(:reference_id) => binary(),
  optional(:refunds) => [refund()],
  optional(:return_amounts) => order_money_amounts(),
  optional(:returns) => [order_return()],
  optional(:rewards) => [order_reward()],
  optional(:rounding_adjustment) => order_rounding_adjustment(),
  optional(:service_charges) => [order_service_charge()],
  optional(:source) => order_source(),
  optional(:state) => binary(),
  optional(:taxes) => [order_line_item_tax()],
  optional(:tenders) => [tender()],
  optional(:total_discount_money) => money(),
  optional(:total_money) => money(),
  optional(:total_service_charge_money) => money(),
  optional(:total_tax_money) => money(),
  optional(:total_tip_money) => money(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}

Specs

order_created() :: %{
  optional(:created_at) => binary(),
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:state) => binary(),
  optional(:version) => integer()
}
Link to this type

order_created_object()

View Source

Specs

order_created_object() :: %{optional(:order_created) => order_created()}

Specs

order_entry() :: %{
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:version) => integer()
}

Specs

order_fulfillment() :: %{
  optional(:metadata) => map(),
  optional(:pickup_details) => order_fulfillment_pickup_details(),
  optional(:shipment_details) => order_fulfillment_shipment_details(),
  optional(:state) => binary(),
  optional(:type) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_fulfillment_pickup_details()

View Source

Specs

order_fulfillment_pickup_details() :: %{
  optional(:accepted_at) => binary(),
  optional(:auto_complete_duration) => binary(),
  optional(:cancel_reason) => binary(),
  optional(:canceled_at) => binary(),
  optional(:curbside_pickup_details) =>
    order_fulfillment_pickup_details_curbside_pickup_details(),
  optional(:expired_at) => binary(),
  optional(:expires_at) => binary(),
  optional(:is_curbside_pickup) => boolean(),
  optional(:note) => binary(),
  optional(:picked_up_at) => binary(),
  optional(:pickup_at) => binary(),
  optional(:pickup_window_duration) => binary(),
  optional(:placed_at) => binary(),
  optional(:prep_time_duration) => binary(),
  optional(:ready_at) => binary(),
  optional(:recipient) => order_fulfillment_recipient(),
  optional(:rejected_at) => binary(),
  optional(:schedule_type) => binary()
}
Link to this type

order_fulfillment_pickup_details_curbside_pickup_details()

View Source

Specs

order_fulfillment_pickup_details_curbside_pickup_details() :: %{
  optional(:buyer_arrived_at) => binary(),
  optional(:curbside_details) => binary()
}
Link to this type

order_fulfillment_pickup_details_schedule_type()

View Source

Specs

order_fulfillment_pickup_details_schedule_type() :: binary()
Link to this type

order_fulfillment_recipient()

View Source

Specs

order_fulfillment_recipient() :: %{
  optional(:address) => address(),
  optional(:customer_id) => binary(),
  optional(:display_name) => binary(),
  optional(:email_address) => binary(),
  optional(:phone_number) => binary()
}
Link to this type

order_fulfillment_shipment_details()

View Source

Specs

order_fulfillment_shipment_details() :: %{
  optional(:cancel_reason) => binary(),
  optional(:canceled_at) => binary(),
  optional(:carrier) => binary(),
  optional(:expected_shipped_at) => binary(),
  optional(:failed_at) => binary(),
  optional(:failure_reason) => binary(),
  optional(:in_progress_at) => binary(),
  optional(:packaged_at) => binary(),
  optional(:placed_at) => binary(),
  optional(:recipient) => order_fulfillment_recipient(),
  optional(:shipped_at) => binary(),
  optional(:shipping_note) => binary(),
  optional(:shipping_type) => binary(),
  optional(:tracking_number) => binary(),
  optional(:tracking_url) => binary()
}
Link to this type

order_fulfillment_state()

View Source

Specs

order_fulfillment_state() :: binary()
Link to this type

order_fulfillment_type()

View Source

Specs

order_fulfillment_type() :: binary()
Link to this type

order_fulfillment_updated()

View Source

Specs

order_fulfillment_updated() :: %{
  optional(:created_at) => binary(),
  optional(:fulfillment_update) => [order_fulfillment_updated_update()],
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:state) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}
Link to this type

order_fulfillment_updated_object()

View Source

Specs

order_fulfillment_updated_object() :: %{
  optional(:order_fulfillment_updated) => order_fulfillment_updated()
}
Link to this type

order_fulfillment_updated_update()

View Source

Specs

order_fulfillment_updated_update() :: %{
  optional(:fulfillment_uid) => binary(),
  optional(:new_state) => binary(),
  optional(:old_state) => binary()
}

Specs

order_line_item() :: %{
  optional(:applied_discounts) => [order_line_item_applied_discount()],
  optional(:applied_taxes) => [order_line_item_applied_tax()],
  optional(:base_price_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:gross_sales_money) => money(),
  optional(:metadata) => map(),
  optional(:modifiers) => [order_line_item_modifier()],
  optional(:name) => binary(),
  optional(:note) => binary(),
  :quantity => binary(),
  optional(:quantity_unit) => order_quantity_unit(),
  optional(:total_discount_money) => money(),
  optional(:total_money) => money(),
  optional(:total_tax_money) => money(),
  optional(:uid) => binary(),
  optional(:variation_name) => binary(),
  optional(:variation_total_price_money) => money()
}
Link to this type

order_line_item_applied_discount()

View Source

Specs

order_line_item_applied_discount() :: %{
  optional(:applied_money) => money(),
  :discount_uid => binary(),
  optional(:uid) => binary()
}
Link to this type

order_line_item_applied_tax()

View Source

Specs

order_line_item_applied_tax() :: %{
  optional(:applied_money) => money(),
  :tax_uid => binary(),
  optional(:uid) => binary()
}
Link to this type

order_line_item_discount()

View Source

Specs

order_line_item_discount() :: %{
  optional(:amount_money) => money(),
  optional(:applied_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:metadata) => map(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:pricing_rule_id) => binary(),
  optional(:reward_ids) => [binary()],
  optional(:scope) => binary(),
  optional(:type) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_line_item_discount_scope()

View Source

Specs

order_line_item_discount_scope() :: binary()
Link to this type

order_line_item_discount_type()

View Source

Specs

order_line_item_discount_type() :: binary()
Link to this type

order_line_item_modifier()

View Source

Specs

order_line_item_modifier() :: %{
  optional(:base_price_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:name) => binary(),
  optional(:total_price_money) => money(),
  optional(:uid) => binary()
}

Specs

order_line_item_tax() :: %{
  optional(:applied_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:metadata) => map(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:scope) => binary(),
  optional(:type) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_line_item_tax_scope()

View Source

Specs

order_line_item_tax_scope() :: binary()
Link to this type

order_line_item_tax_type()

View Source

Specs

order_line_item_tax_type() :: binary()

Specs

order_money_amounts() :: %{
  optional(:discount_money) => money(),
  optional(:service_charge_money) => money(),
  optional(:tax_money) => money(),
  optional(:tip_money) => money(),
  optional(:total_money) => money()
}
Link to this type

order_pricing_options()

View Source

Specs

order_pricing_options() :: %{optional(:auto_apply_discounts) => boolean()}

Specs

order_quantity_unit() :: %{
  optional(:measurement_unit) => measurement_unit(),
  optional(:precision) => integer()
}

Specs

order_return() :: %{
  optional(:return_amounts) => order_money_amounts(),
  optional(:return_discounts) => [order_return_discount()],
  optional(:return_line_items) => [order_return_line_item()],
  optional(:return_service_charges) => [order_return_service_charge()],
  optional(:return_taxes) => [order_return_tax()],
  optional(:rounding_adjustment) => order_rounding_adjustment(),
  optional(:source_order_id) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_return_discount()

View Source

Specs

order_return_discount() :: %{
  optional(:amount_money) => money(),
  optional(:applied_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:scope) => binary(),
  optional(:source_discount_uid) => binary(),
  optional(:type) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_return_line_item()

View Source

Specs

order_return_line_item() :: %{
  optional(:applied_discounts) => [order_line_item_applied_discount()],
  optional(:applied_taxes) => [order_line_item_applied_tax()],
  optional(:base_price_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:gross_return_money) => money(),
  optional(:name) => binary(),
  optional(:note) => binary(),
  :quantity => binary(),
  optional(:quantity_unit) => order_quantity_unit(),
  optional(:return_modifiers) => [order_return_line_item_modifier()],
  optional(:source_line_item_uid) => binary(),
  optional(:total_discount_money) => money(),
  optional(:total_money) => money(),
  optional(:total_tax_money) => money(),
  optional(:uid) => binary(),
  optional(:variation_name) => binary(),
  optional(:variation_total_price_money) => money()
}
Link to this type

order_return_line_item_modifier()

View Source

Specs

order_return_line_item_modifier() :: %{
  optional(:base_price_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:name) => binary(),
  optional(:source_modifier_uid) => binary(),
  optional(:total_price_money) => money(),
  optional(:uid) => binary()
}
Link to this type

order_return_service_charge()

View Source

Specs

order_return_service_charge() :: %{
  optional(:amount_money) => money(),
  optional(:applied_money) => money(),
  optional(:applied_taxes) => [order_line_item_applied_tax()],
  optional(:calculation_phase) => binary(),
  optional(:catalog_object_id) => binary(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:source_service_charge_uid) => binary(),
  optional(:taxable) => boolean(),
  optional(:total_money) => money(),
  optional(:total_tax_money) => money(),
  optional(:uid) => binary()
}

Specs

order_return_tax() :: %{
  optional(:applied_money) => money(),
  optional(:catalog_object_id) => binary(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:scope) => binary(),
  optional(:source_tax_uid) => binary(),
  optional(:type) => binary(),
  optional(:uid) => binary()
}

Specs

order_reward() :: %{id: binary(), reward_tier_id: binary()}
Link to this type

order_rounding_adjustment()

View Source

Specs

order_rounding_adjustment() :: %{
  optional(:amount_money) => money(),
  optional(:name) => binary(),
  optional(:uid) => binary()
}
Link to this type

order_service_charge()

View Source

Specs

order_service_charge() :: %{
  optional(:amount_money) => money(),
  optional(:applied_money) => money(),
  optional(:applied_taxes) => [order_line_item_applied_tax()],
  optional(:calculation_phase) => binary(),
  optional(:catalog_object_id) => binary(),
  optional(:metadata) => map(),
  optional(:name) => binary(),
  optional(:percentage) => binary(),
  optional(:taxable) => boolean(),
  optional(:total_money) => money(),
  optional(:total_tax_money) => money(),
  optional(:uid) => binary()
}
Link to this type

order_service_charge_calculation_phase()

View Source

Specs

order_service_charge_calculation_phase() :: binary()

Specs

order_source() :: %{optional(:name) => binary()}

Specs

order_state() :: binary()

Specs

order_updated() :: %{
  optional(:created_at) => binary(),
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:state) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}
Link to this type

order_updated_object()

View Source

Specs

order_updated_object() :: %{optional(:order_updated) => order_updated()}

Specs

pay_order_request() :: %{
  :idempotency_key => binary(),
  optional(:order_version) => integer(),
  optional(:payment_ids) => [binary()]
}

Specs

pay_order_response() :: %{
  optional(:errors) => [error()],
  optional(:order) => order()
}

Specs

payment() :: %{
  optional(:amount_money) => money(),
  optional(:app_fee_money) => money(),
  optional(:billing_address) => address(),
  optional(:buyer_email_address) => binary(),
  optional(:card_details) => card_payment_details(),
  optional(:created_at) => binary(),
  optional(:customer_id) => binary(),
  optional(:delay_action) => binary(),
  optional(:delay_duration) => binary(),
  optional(:delayed_until) => binary(),
  optional(:employee_id) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:note) => binary(),
  optional(:order_id) => binary(),
  optional(:processing_fee) => [processing_fee()],
  optional(:receipt_number) => binary(),
  optional(:receipt_url) => binary(),
  optional(:reference_id) => binary(),
  optional(:refund_ids) => [binary()],
  optional(:refunded_money) => money(),
  optional(:shipping_address) => address(),
  optional(:source_type) => binary(),
  optional(:statement_description_identifier) => binary(),
  optional(:status) => binary(),
  optional(:tip_money) => money(),
  optional(:total_money) => money(),
  optional(:updated_at) => binary()
}

Specs

payment_options() :: %{optional(:autocomplete) => boolean()}

Specs

payment_refund() :: %{
  :amount_money => money(),
  optional(:app_fee_money) => money(),
  optional(:created_at) => binary(),
  :id => binary(),
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:payment_id) => binary(),
  optional(:processing_fee) => [processing_fee()],
  optional(:reason) => binary(),
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}

Specs

processing_fee() :: %{
  optional(:amount_money) => money(),
  optional(:effective_at) => binary(),
  optional(:type) => binary()
}

Specs

product() :: binary()

Specs

product_type() :: binary()
Link to this type

publish_invoice_request()

View Source

Specs

publish_invoice_request() :: %{
  optional(:idempotency_key) => binary(),
  :version => integer()
}
Link to this type

publish_invoice_response()

View Source

Specs

publish_invoice_response() :: %{
  optional(:errors) => [error()],
  optional(:invoice) => invoice()
}

Specs

range() :: %{optional(:max) => binary(), optional(:min) => binary()}
Link to this type

redeem_loyalty_reward_request()

View Source

Specs

redeem_loyalty_reward_request() :: %{
  idempotency_key: binary(),
  location_id: binary()
}
Link to this type

redeem_loyalty_reward_response()

View Source

Specs

redeem_loyalty_reward_response() :: %{
  optional(:errors) => [error()],
  optional(:event) => loyalty_event()
}

Specs

refund() :: %{
  optional(:additional_recipients) => [additional_recipient()],
  :amount_money => money(),
  optional(:created_at) => binary(),
  :id => binary(),
  :location_id => binary(),
  optional(:processing_fee_money) => money(),
  :reason => binary(),
  :status => binary(),
  :tender_id => binary(),
  :transaction_id => binary()
}
Link to this type

refund_payment_request()

View Source

Specs

refund_payment_request() :: %{
  :amount_money => money(),
  optional(:app_fee_money) => money(),
  :idempotency_key => binary(),
  :payment_id => binary(),
  optional(:reason) => binary()
}
Link to this type

refund_payment_response()

View Source

Specs

refund_payment_response() :: %{
  optional(:errors) => [error()],
  optional(:refund) => payment_refund()
}

Specs

refund_status() :: binary()
Link to this type

register_domain_request()

View Source

Specs

register_domain_request() :: %{domain_name: binary()}
Link to this type

register_domain_response()

View Source

Specs

register_domain_response() :: %{
  optional(:errors) => [error()],
  optional(:status) => binary()
}
Link to this type

register_domain_response_status()

View Source

Specs

register_domain_response_status() :: binary()
Link to this type

remove_dispute_evidence_request()

View Source

Specs

remove_dispute_evidence_request() :: %{}
Link to this type

remove_dispute_evidence_response()

View Source

Specs

remove_dispute_evidence_response() :: %{optional(:errors) => [error()]}
Link to this type

remove_group_from_customer_request()

View Source

Specs

remove_group_from_customer_request() :: %{}
Link to this type

remove_group_from_customer_response()

View Source

Specs

remove_group_from_customer_response() :: %{optional(:errors) => [error()]}

Specs

renew_token_request() :: %{optional(:access_token) => binary()}
Link to this type

renew_token_response()

View Source

Specs

renew_token_response() :: %{
  optional(:access_token) => binary(),
  optional(:expires_at) => binary(),
  optional(:merchant_id) => binary(),
  optional(:plan_id) => binary(),
  optional(:subscription_id) => binary(),
  optional(:token_type) => binary()
}
Link to this type

retrieve_cash_drawer_shift_request()

View Source

Specs

retrieve_cash_drawer_shift_request() :: %{location_id: binary()}
Link to this type

retrieve_cash_drawer_shift_response()

View Source

Specs

retrieve_cash_drawer_shift_response() :: %{
  optional(:cash_drawer_shift) => cash_drawer_shift(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_catalog_object_request()

View Source

Specs

retrieve_catalog_object_request() :: %{
  optional(:include_related_objects) => boolean()
}
Link to this type

retrieve_catalog_object_response()

View Source

Specs

retrieve_catalog_object_response() :: %{
  optional(:errors) => [error()],
  optional(:object) => catalog_object(),
  optional(:related_objects) => [catalog_object()]
}
Link to this type

retrieve_customer_group_request()

View Source

Specs

retrieve_customer_group_request() :: %{}
Link to this type

retrieve_customer_group_response()

View Source

Specs

retrieve_customer_group_response() :: %{
  optional(:errors) => [error()],
  optional(:group) => customer_group()
}
Link to this type

retrieve_customer_request()

View Source

Specs

retrieve_customer_request() :: %{}
Link to this type

retrieve_customer_response()

View Source

Specs

retrieve_customer_response() :: %{
  optional(:customer) => customer(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_customer_segment_request()

View Source

Specs

retrieve_customer_segment_request() :: %{}
Link to this type

retrieve_customer_segment_response()

View Source

Specs

retrieve_customer_segment_response() :: %{
  optional(:errors) => [error()],
  optional(:segment) => customer_segment()
}
Link to this type

retrieve_dispute_evidence_request()

View Source

Specs

retrieve_dispute_evidence_request() :: %{}
Link to this type

retrieve_dispute_evidence_response()

View Source

Specs

retrieve_dispute_evidence_response() :: %{
  optional(:errors) => [error()],
  optional(:evidence) => dispute_evidence()
}
Link to this type

retrieve_dispute_request()

View Source

Specs

retrieve_dispute_request() :: %{}
Link to this type

retrieve_dispute_response()

View Source

Specs

retrieve_dispute_response() :: %{
  optional(:dispute) => dispute(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_employee_request()

View Source

Specs

retrieve_employee_request() :: %{}
Link to this type

retrieve_employee_response()

View Source

Specs

retrieve_employee_response() :: %{
  optional(:employee) => employee(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_inventory_adjustment_request()

View Source

Specs

retrieve_inventory_adjustment_request() :: %{}
Link to this type

retrieve_inventory_adjustment_response()

View Source

Specs

retrieve_inventory_adjustment_response() :: %{
  optional(:adjustment) => inventory_adjustment(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_inventory_changes_request()

View Source

Specs

retrieve_inventory_changes_request() :: %{
  optional(:cursor) => binary(),
  optional(:location_ids) => binary()
}
Link to this type

retrieve_inventory_changes_response()

View Source

Specs

retrieve_inventory_changes_response() :: %{
  optional(:changes) => [inventory_change()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_inventory_count_request()

View Source

Specs

retrieve_inventory_count_request() :: %{
  optional(:cursor) => binary(),
  optional(:location_ids) => binary()
}
Link to this type

retrieve_inventory_count_response()

View Source

Specs

retrieve_inventory_count_response() :: %{
  optional(:counts) => [inventory_count()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_inventory_physical_count_request()

View Source

Specs

retrieve_inventory_physical_count_request() :: %{}
Link to this type

retrieve_inventory_physical_count_response()

View Source

Specs

retrieve_inventory_physical_count_response() :: %{
  optional(:count) => inventory_physical_count(),
  optional(:errors) => [error()]
}
Link to this type

retrieve_location_request()

View Source

Specs

retrieve_location_request() :: %{}
Link to this type

retrieve_location_response()

View Source

Specs

retrieve_location_response() :: %{
  optional(:errors) => [error()],
  optional(:location) => location()
}
Link to this type

retrieve_loyalty_account_request()

View Source

Specs

retrieve_loyalty_account_request() :: %{}
Link to this type

retrieve_loyalty_account_response()

View Source

Specs

retrieve_loyalty_account_response() :: %{
  optional(:errors) => [error()],
  optional(:loyalty_account) => loyalty_account()
}
Link to this type

retrieve_loyalty_reward_request()

View Source

Specs

retrieve_loyalty_reward_request() :: %{}
Link to this type

retrieve_loyalty_reward_response()

View Source

Specs

retrieve_loyalty_reward_response() :: %{
  optional(:errors) => [error()],
  optional(:reward) => loyalty_reward()
}
Link to this type

retrieve_merchant_request()

View Source

Specs

retrieve_merchant_request() :: %{}
Link to this type

retrieve_merchant_response()

View Source

Specs

retrieve_merchant_response() :: %{
  optional(:errors) => [error()],
  optional(:merchant) => merchant()
}
Link to this type

retrieve_subscription_request()

View Source

Specs

retrieve_subscription_request() :: %{}
Link to this type

retrieve_subscription_response()

View Source

Specs

retrieve_subscription_response() :: %{
  optional(:errors) => [error()],
  optional(:subscription) => subscription()
}
Link to this type

retrieve_team_member_request()

View Source

Specs

retrieve_team_member_request() :: %{}
Link to this type

retrieve_team_member_response()

View Source

Specs

retrieve_team_member_response() :: %{
  optional(:errors) => [error()],
  optional(:team_member) => team_member()
}
Link to this type

retrieve_transaction_request()

View Source

Specs

retrieve_transaction_request() :: %{}
Link to this type

retrieve_transaction_response()

View Source

Specs

retrieve_transaction_response() :: %{
  optional(:errors) => [error()],
  optional(:transaction) => transaction()
}
Link to this type

retrieve_wage_setting_request()

View Source

Specs

retrieve_wage_setting_request() :: %{}
Link to this type

retrieve_wage_setting_response()

View Source

Specs

retrieve_wage_setting_response() :: %{
  optional(:errors) => [error()],
  optional(:wage_setting) => wage_setting()
}
Link to this type

revoke_token_request()

View Source

Specs

revoke_token_request() :: %{
  optional(:access_token) => binary(),
  optional(:client_id) => binary(),
  optional(:merchant_id) => binary(),
  optional(:revoke_only_access_token) => boolean()
}
Link to this type

revoke_token_response()

View Source

Specs

revoke_token_response() :: %{optional(:success) => boolean()}
Link to this type

search_catalog_items_request()

View Source

Specs

search_catalog_items_request() :: %{
  optional(:category_ids) => [binary()],
  optional(:cursor) => binary(),
  optional(:custom_attribute_filters) => [custom_attribute_filter()],
  optional(:enabled_location_ids) => [binary()],
  optional(:limit) => integer(),
  optional(:product_types) => [binary()],
  optional(:sort_order) => binary(),
  optional(:stock_levels) => [binary()],
  optional(:text_filter) => binary()
}
Link to this type

search_catalog_items_request_stock_level()

View Source

Specs

search_catalog_items_request_stock_level() :: binary()
Link to this type

search_catalog_items_response()

View Source

Specs

search_catalog_items_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:items) => [catalog_object()],
  optional(:matched_variation_ids) => [binary()]
}
Link to this type

search_catalog_objects_request()

View Source

Specs

search_catalog_objects_request() :: %{
  optional(:begin_time) => binary(),
  optional(:cursor) => binary(),
  optional(:include_deleted_objects) => boolean(),
  optional(:include_related_objects) => boolean(),
  optional(:limit) => integer(),
  optional(:object_types) => [binary()],
  optional(:query) => catalog_query()
}
Link to this type

search_catalog_objects_response()

View Source

Specs

search_catalog_objects_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:latest_time) => binary(),
  optional(:objects) => [catalog_object()],
  optional(:related_objects) => [catalog_object()]
}
Link to this type

search_customers_request()

View Source

Specs

search_customers_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => customer_query()
}
Link to this type

search_customers_response()

View Source

Specs

search_customers_response() :: %{
  optional(:cursor) => binary(),
  optional(:customers) => [customer()],
  optional(:errors) => [error()]
}
Link to this type

search_invoices_request()

View Source

Specs

search_invoices_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  :query => invoice_query()
}
Link to this type

search_invoices_response()

View Source

Specs

search_invoices_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:invoices) => [invoice()]
}
Link to this type

search_loyalty_accounts_request()

View Source

Specs

search_loyalty_accounts_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => search_loyalty_accounts_request_loyalty_account_query()
}
Link to this type

search_loyalty_accounts_request_loyalty_account_query()

View Source

Specs

search_loyalty_accounts_request_loyalty_account_query() :: %{
  optional(:mappings) => [loyalty_account_mapping()]
}
Link to this type

search_loyalty_accounts_response()

View Source

Specs

search_loyalty_accounts_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:loyalty_accounts) => [loyalty_account()]
}
Link to this type

search_loyalty_events_request()

View Source

Specs

search_loyalty_events_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => loyalty_event_query()
}
Link to this type

search_loyalty_events_response()

View Source

Specs

search_loyalty_events_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:events) => [loyalty_event()]
}
Link to this type

search_loyalty_rewards_request()

View Source

Specs

search_loyalty_rewards_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => search_loyalty_rewards_request_loyalty_reward_query()
}
Link to this type

search_loyalty_rewards_request_loyalty_reward_query()

View Source

Specs

search_loyalty_rewards_request_loyalty_reward_query() :: %{
  :loyalty_account_id => binary(),
  optional(:status) => binary()
}
Link to this type

search_loyalty_rewards_response()

View Source

Specs

search_loyalty_rewards_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:rewards) => [loyalty_reward()]
}
Link to this type

search_orders_customer_filter()

View Source

Specs

search_orders_customer_filter() :: %{optional(:customer_ids) => [binary()]}
Link to this type

search_orders_date_time_filter()

View Source

Specs

search_orders_date_time_filter() :: %{
  optional(:closed_at) => time_range(),
  optional(:created_at) => time_range(),
  optional(:updated_at) => time_range()
}
Link to this type

search_orders_filter()

View Source

Specs

search_orders_filter() :: %{
  optional(:customer_filter) => search_orders_customer_filter(),
  optional(:date_time_filter) => search_orders_date_time_filter(),
  optional(:fulfillment_filter) => search_orders_fulfillment_filter(),
  optional(:source_filter) => search_orders_source_filter(),
  optional(:state_filter) => search_orders_state_filter()
}
Link to this type

search_orders_fulfillment_filter()

View Source

Specs

search_orders_fulfillment_filter() :: %{
  optional(:fulfillment_states) => [binary()],
  optional(:fulfillment_types) => [binary()]
}

Specs

search_orders_query() :: %{
  optional(:filter) => search_orders_filter(),
  optional(:sort) => search_orders_sort()
}
Link to this type

search_orders_request()

View Source

Specs

search_orders_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:location_ids) => [binary()],
  optional(:query) => search_orders_query(),
  optional(:return_entries) => boolean()
}
Link to this type

search_orders_response()

View Source

Specs

search_orders_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:order_entries) => [order_entry()],
  optional(:orders) => [order()]
}

Specs

search_orders_sort() :: %{
  :sort_field => binary(),
  optional(:sort_order) => binary()
}
Link to this type

search_orders_sort_field()

View Source

Specs

search_orders_sort_field() :: binary()
Link to this type

search_orders_source_filter()

View Source

Specs

search_orders_source_filter() :: %{optional(:source_names) => [binary()]}
Link to this type

search_orders_state_filter()

View Source

Specs

search_orders_state_filter() :: %{states: [binary()]}
Link to this type

search_shifts_request()

View Source

Specs

search_shifts_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => shift_query()
}
Link to this type

search_shifts_response()

View Source

Specs

search_shifts_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:shifts) => [shift()]
}
Link to this type

search_subscriptions_filter()

View Source

Specs

search_subscriptions_filter() :: %{
  optional(:customer_ids) => [binary()],
  optional(:location_ids) => [binary()]
}
Link to this type

search_subscriptions_query()

View Source

Specs

search_subscriptions_query() :: %{
  optional(:filter) => search_subscriptions_filter()
}
Link to this type

search_subscriptions_request()

View Source

Specs

search_subscriptions_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => search_subscriptions_query()
}
Link to this type

search_subscriptions_response()

View Source

Specs

search_subscriptions_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:subscriptions) => [subscription()]
}
Link to this type

search_team_members_filter()

View Source

Specs

search_team_members_filter() :: %{
  optional(:location_ids) => [binary()],
  optional(:status) => binary()
}
Link to this type

search_team_members_query()

View Source

Specs

search_team_members_query() :: %{
  optional(:filter) => search_team_members_filter()
}
Link to this type

search_team_members_request()

View Source

Specs

search_team_members_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => search_team_members_query()
}
Link to this type

search_team_members_response()

View Source

Specs

search_team_members_response() :: %{
  optional(:cursor) => binary(),
  optional(:errors) => [error()],
  optional(:team_members) => [team_member()]
}
Link to this type

search_terminal_checkouts_request()

View Source

Specs

search_terminal_checkouts_request() :: %{
  optional(:cursor) => binary(),
  optional(:limit) => integer(),
  optional(:query) => terminal_checkout_query()
}
Link to this type

search_terminal_checkouts_response()

View Source

Specs

search_terminal_checkouts_response() :: %{
  optional(:checkouts) => [terminal_checkout()],
  optional(:cursor) => binary(),
  optional(:errors) => [error()]
}

Specs

shift() :: %{
  optional(:breaks) => [break()],
  optional(:created_at) => binary(),
  optional(:employee_id) => binary(),
  optional(:end_at) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  :start_at => binary(),
  optional(:status) => binary(),
  optional(:team_member_id) => binary(),
  optional(:timezone) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer(),
  optional(:wage) => shift_wage()
}

Specs

shift_filter() :: %{
  optional(:employee_ids) => [binary()],
  optional(:end) => time_range(),
  :location_ids => [binary()],
  optional(:start) => time_range(),
  optional(:status) => binary(),
  :team_member_ids => [binary()],
  optional(:workday) => shift_workday()
}

Specs

shift_filter_status() :: binary()

Specs

shift_query() :: %{
  optional(:filter) => shift_filter(),
  optional(:sort) => shift_sort()
}

Specs

shift_sort() :: %{optional(:field) => binary(), optional(:order) => binary()}

Specs

shift_sort_field() :: binary()

Specs

shift_status() :: binary()

Specs

shift_wage() :: %{
  optional(:hourly_rate) => money(),
  optional(:title) => binary()
}

Specs

shift_workday() :: %{
  optional(:date_range) => date_range(),
  optional(:default_timezone) => binary(),
  optional(:match_shifts_by) => binary()
}
Link to this type

shift_workday_matcher()

View Source

Specs

shift_workday_matcher() :: binary()

Specs

sort_order() :: binary()

Specs

source_application() :: %{
  optional(:application_id) => binary(),
  optional(:name) => binary(),
  optional(:product) => binary()
}
Link to this type

standard_unit_description()

View Source

Specs

standard_unit_description() :: %{
  optional(:abbreviation) => binary(),
  optional(:name) => binary(),
  optional(:unit) => measurement_unit()
}
Link to this type

standard_unit_description_group()

View Source

Specs

standard_unit_description_group() :: %{
  optional(:language_code) => binary(),
  optional(:standard_unit_descriptions) => [standard_unit_description()]
}
Link to this type

submit_evidence_request()

View Source

Specs

submit_evidence_request() :: %{}
Link to this type

submit_evidence_response()

View Source

Specs

submit_evidence_response() :: %{
  optional(:dispute) => dispute(),
  optional(:errors) => [error()]
}

Specs

subscription() :: %{
  optional(:canceled_date) => binary(),
  optional(:card_id) => binary(),
  optional(:created_at) => binary(),
  optional(:customer_id) => binary(),
  optional(:id) => binary(),
  optional(:invoice_ids) => [binary()],
  optional(:location_id) => binary(),
  optional(:paid_until_date) => binary(),
  optional(:plan_id) => binary(),
  optional(:price_override_money) => money(),
  optional(:start_date) => binary(),
  optional(:status) => binary(),
  optional(:tax_percentage) => binary(),
  optional(:timezone) => binary(),
  optional(:version) => integer()
}
Link to this type

subscription_cadence()

View Source

Specs

subscription_cadence() :: binary()

Specs

subscription_event() :: %{
  effective_date: binary(),
  id: binary(),
  plan_id: binary(),
  subscription_event_type: binary()
}
Link to this type

subscription_event_subscription_event_type()

View Source

Specs

subscription_event_subscription_event_type() :: binary()

Specs

subscription_phase() :: %{
  :cadence => binary(),
  optional(:ordinal) => integer(),
  optional(:periods) => integer(),
  :recurring_price_money => money(),
  optional(:uid) => binary()
}

Specs

subscription_status() :: binary()
Link to this type

tax_calculation_phase()

View Source

Specs

tax_calculation_phase() :: binary()

Specs

tax_inclusion_type() :: binary()

Specs

team_member() :: %{
  optional(:assigned_locations) => team_member_assigned_locations(),
  optional(:created_at) => binary(),
  optional(:email_address) => binary(),
  optional(:family_name) => binary(),
  optional(:given_name) => binary(),
  optional(:id) => binary(),
  optional(:is_owner) => boolean(),
  optional(:phone_number) => binary(),
  optional(:reference_id) => binary(),
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}
Link to this type

team_member_assigned_locations()

View Source

Specs

team_member_assigned_locations() :: %{
  optional(:assignment_type) => binary(),
  optional(:location_ids) => [binary()]
}
Link to this type

team_member_assigned_locations_assignment_type()

View Source

Specs

team_member_assigned_locations_assignment_type() :: binary()

Specs

team_member_status() :: binary()

Specs

team_member_wage() :: %{
  optional(:hourly_rate) => money(),
  optional(:id) => binary(),
  optional(:team_member_id) => binary(),
  optional(:title) => binary()
}

Specs

tender() :: %{
  optional(:additional_recipients) => [additional_recipient()],
  optional(:amount_money) => money(),
  optional(:bank_transfer_details) => tender_bank_transfer_details(),
  optional(:card_details) => tender_card_details(),
  optional(:cash_details) => tender_cash_details(),
  optional(:created_at) => binary(),
  optional(:customer_id) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:note) => binary(),
  optional(:payment_id) => binary(),
  optional(:processing_fee_money) => money(),
  optional(:tip_money) => money(),
  optional(:transaction_id) => binary(),
  :type => binary()
}
Link to this type

tender_bank_transfer_details()

View Source

Specs

tender_bank_transfer_details() :: %{optional(:status) => binary()}
Link to this type

tender_bank_transfer_details_status()

View Source

Specs

tender_bank_transfer_details_status() :: binary()

Specs

tender_card_details() :: %{
  optional(:card) => card(),
  optional(:entry_method) => binary(),
  optional(:status) => binary()
}
Link to this type

tender_card_details_entry_method()

View Source

Specs

tender_card_details_entry_method() :: binary()
Link to this type

tender_card_details_status()

View Source

Specs

tender_card_details_status() :: binary()

Specs

tender_cash_details() :: %{
  optional(:buyer_tendered_money) => money(),
  optional(:change_back_money) => money()
}

Specs

tender_type() :: binary()

Specs

terminal_checkout() :: %{
  :amount_money => money(),
  optional(:cancel_reason) => binary(),
  optional(:created_at) => binary(),
  optional(:deadline_duration) => binary(),
  :device_options => device_checkout_options(),
  optional(:id) => binary(),
  optional(:note) => binary(),
  optional(:payment_ids) => [binary()],
  optional(:reference_id) => binary(),
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}
Link to this type

terminal_checkout_query()

View Source

Specs

terminal_checkout_query() :: %{
  optional(:filter) => terminal_checkout_query_filter(),
  optional(:sort) => terminal_checkout_query_sort()
}
Link to this type

terminal_checkout_query_filter()

View Source

Specs

terminal_checkout_query_filter() :: %{
  optional(:created_at) => time_range(),
  optional(:device_id) => binary(),
  optional(:status) => binary()
}
Link to this type

terminal_checkout_query_sort()

View Source

Specs

terminal_checkout_query_sort() :: %{optional(:sort_order) => binary()}

Specs

time_range() :: %{
  optional(:end_at) => binary(),
  optional(:start_at) => binary()
}

Specs

tip_settings() :: %{
  optional(:allow_tipping) => boolean(),
  optional(:custom_tip_field) => boolean(),
  optional(:separate_tip_screen) => boolean()
}

Specs

transaction() :: %{
  optional(:client_id) => binary(),
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  optional(:location_id) => binary(),
  optional(:order_id) => binary(),
  optional(:product) => binary(),
  optional(:reference_id) => binary(),
  optional(:refunds) => [refund()],
  optional(:shipping_address) => address(),
  optional(:tenders) => [tender()]
}

Specs

transaction_product() :: binary()

Specs

transaction_type() :: binary()
Link to this type

update_break_type_request()

View Source

Specs

update_break_type_request() :: %{break_type: break_type()}
Link to this type

update_break_type_response()

View Source

Specs

update_break_type_response() :: %{
  optional(:break_type) => break_type(),
  optional(:errors) => [error()]
}
Link to this type

update_customer_group_request()

View Source

Specs

update_customer_group_request() :: %{group: customer_group()}
Link to this type

update_customer_group_response()

View Source

Specs

update_customer_group_response() :: %{
  optional(:errors) => [error()],
  optional(:group) => customer_group()
}
Link to this type

update_customer_request()

View Source

Specs

update_customer_request() :: %{
  optional(:address) => address(),
  optional(:birthday) => binary(),
  optional(:company_name) => binary(),
  optional(:email_address) => binary(),
  optional(:family_name) => binary(),
  optional(:given_name) => binary(),
  optional(:nickname) => binary(),
  optional(:note) => binary(),
  optional(:phone_number) => binary(),
  optional(:reference_id) => binary()
}
Link to this type

update_customer_response()

View Source

Specs

update_customer_response() :: %{
  optional(:customer) => customer(),
  optional(:errors) => [error()]
}
Link to this type

update_invoice_request()

View Source

Specs

update_invoice_request() :: %{
  optional(:fields_to_clear) => [binary()],
  optional(:idempotency_key) => binary(),
  :invoice => invoice()
}
Link to this type

update_invoice_response()

View Source

Specs

update_invoice_response() :: %{
  optional(:errors) => [error()],
  optional(:invoice) => invoice()
}
Link to this type

update_item_modifier_lists_request()

View Source

Specs

update_item_modifier_lists_request() :: %{
  :item_ids => [binary()],
  optional(:modifier_lists_to_disable) => [binary()],
  optional(:modifier_lists_to_enable) => [binary()]
}
Link to this type

update_item_modifier_lists_response()

View Source

Specs

update_item_modifier_lists_response() :: %{
  optional(:errors) => [error()],
  optional(:updated_at) => binary()
}
Link to this type

update_item_taxes_request()

View Source

Specs

update_item_taxes_request() :: %{
  :item_ids => [binary()],
  optional(:taxes_to_disable) => [binary()],
  optional(:taxes_to_enable) => [binary()]
}
Link to this type

update_item_taxes_response()

View Source

Specs

update_item_taxes_response() :: %{
  optional(:errors) => [error()],
  optional(:updated_at) => binary()
}
Link to this type

update_location_request()

View Source

Specs

update_location_request() :: %{optional(:location) => location()}
Link to this type

update_location_response()

View Source

Specs

update_location_response() :: %{
  optional(:errors) => [error()],
  optional(:location) => location()
}
Link to this type

update_order_request()

View Source

Specs

update_order_request() :: %{
  optional(:fields_to_clear) => [binary()],
  optional(:idempotency_key) => binary(),
  optional(:order) => order()
}
Link to this type

update_order_response()

View Source

Specs

update_order_response() :: %{
  optional(:errors) => [error()],
  optional(:order) => order()
}
Link to this type

update_shift_request()

View Source

Specs

update_shift_request() :: %{shift: shift()}
Link to this type

update_shift_response()

View Source

Specs

update_shift_response() :: %{
  optional(:errors) => [error()],
  optional(:shift) => shift()
}
Link to this type

update_subscription_request()

View Source

Specs

update_subscription_request() :: %{optional(:subscription) => subscription()}
Link to this type

update_subscription_response()

View Source

Specs

update_subscription_response() :: %{
  optional(:errors) => [error()],
  optional(:subscription) => subscription()
}
Link to this type

update_team_member_request()

View Source

Specs

update_team_member_request() :: %{optional(:team_member) => team_member()}
Link to this type

update_team_member_response()

View Source

Specs

update_team_member_response() :: %{
  optional(:errors) => [error()],
  optional(:team_member) => team_member()
}
Link to this type

update_wage_setting_request()

View Source

Specs

update_wage_setting_request() :: %{wage_setting: wage_setting()}
Link to this type

update_wage_setting_response()

View Source

Specs

update_wage_setting_response() :: %{
  optional(:errors) => [error()],
  optional(:wage_setting) => wage_setting()
}
Link to this type

update_workweek_config_request()

View Source

Specs

update_workweek_config_request() :: %{workweek_config: workweek_config()}
Link to this type

update_workweek_config_response()

View Source

Specs

update_workweek_config_response() :: %{
  optional(:errors) => [error()],
  optional(:workweek_config) => workweek_config()
}
Link to this type

upsert_catalog_object_request()

View Source

Specs

upsert_catalog_object_request() :: %{
  idempotency_key: binary(),
  object: catalog_object()
}
Link to this type

upsert_catalog_object_response()

View Source

Specs

upsert_catalog_object_response() :: %{
  optional(:catalog_object) => catalog_object(),
  optional(:errors) => [error()],
  optional(:id_mappings) => [catalog_id_mapping()]
}
Link to this type

v1_adjust_inventory_request()

View Source

Specs

v1_adjust_inventory_request() :: %{
  optional(:adjustment_type) => binary(),
  optional(:memo) => binary(),
  optional(:quantity_delta) => number()
}
Link to this type

v1_adjust_inventory_request_adjustment_type()

View Source

Specs

v1_adjust_inventory_request_adjustment_type() :: binary()
Link to this type

v1_apply_fee_request()

View Source

Specs

v1_apply_fee_request() :: %{}
Link to this type

v1_apply_modifier_list_request()

View Source

Specs

v1_apply_modifier_list_request() :: %{}

Specs

v1_bank_account() :: %{
  optional(:account_number_suffix) => binary(),
  optional(:bank_name) => binary(),
  optional(:currency_code) => binary(),
  optional(:id) => binary(),
  optional(:merchant_id) => binary(),
  optional(:name) => binary(),
  optional(:routing_number) => binary(),
  optional(:type) => binary()
}
Link to this type

v1_bank_account_type()

View Source

Specs

v1_bank_account_type() :: binary()
Link to this type

v1_cash_drawer_event()

View Source

Specs

v1_cash_drawer_event() :: %{
  optional(:created_at) => binary(),
  optional(:description) => binary(),
  optional(:employee_id) => binary(),
  optional(:event_money) => v1_money(),
  optional(:event_type) => binary(),
  optional(:id) => binary()
}
Link to this type

v1_cash_drawer_event_event_type()

View Source

Specs

v1_cash_drawer_event_event_type() :: binary()
Link to this type

v1_cash_drawer_shift()

View Source

Specs

v1_cash_drawer_shift() :: %{
  optional(:cash_paid_in_money) => v1_money(),
  optional(:cash_paid_out_money) => v1_money(),
  optional(:cash_payment_money) => v1_money(),
  optional(:cash_refunds_money) => v1_money(),
  optional(:closed_at) => binary(),
  optional(:closed_cash_money) => v1_money(),
  optional(:closing_employee_id) => binary(),
  optional(:description) => binary(),
  optional(:device) => device(),
  optional(:employee_ids) => [binary()],
  optional(:ended_at) => binary(),
  optional(:ending_employee_id) => binary(),
  optional(:event_type) => binary(),
  optional(:events) => [v1_cash_drawer_event()],
  optional(:expected_cash_money) => v1_money(),
  optional(:id) => binary(),
  optional(:opened_at) => binary(),
  optional(:opening_employee_id) => binary(),
  optional(:starting_cash_money) => v1_money()
}
Link to this type

v1_cash_drawer_shift_event_type()

View Source

Specs

v1_cash_drawer_shift_event_type() :: binary()

Specs

v1_category() :: %{
  optional(:id) => binary(),
  optional(:name) => binary(),
  optional(:v2_id) => binary()
}
Link to this type

v1_create_category_request()

View Source

Specs

v1_create_category_request() :: %{optional(:body) => v1_category()}
Link to this type

v1_create_discount_request()

View Source

Specs

v1_create_discount_request() :: %{optional(:body) => v1_discount()}
Link to this type

v1_create_employee_role_request()

View Source

Specs

v1_create_employee_role_request() :: %{
  optional(:employee_role) => v1_employee_role()
}
Link to this type

v1_create_fee_request()

View Source

Specs

v1_create_fee_request() :: %{optional(:body) => v1_fee()}
Link to this type

v1_create_item_request()

View Source

Specs

v1_create_item_request() :: %{optional(:body) => v1_item()}
Link to this type

v1_create_modifier_list_request()

View Source

Specs

v1_create_modifier_list_request() :: %{optional(:body) => v1_modifier_list()}
Link to this type

v1_create_modifier_option_request()

View Source

Specs

v1_create_modifier_option_request() :: %{
  optional(:body) => v1_modifier_option()
}
Link to this type

v1_create_page_request()

View Source

Specs

v1_create_page_request() :: %{optional(:body) => v1_page()}
Link to this type

v1_create_refund_request()

View Source

Specs

v1_create_refund_request() :: %{
  :payment_id => binary(),
  :reason => binary(),
  optional(:refunded_money) => v1_money(),
  optional(:request_idempotence_key) => binary(),
  :type => binary()
}
Link to this type

v1_create_refund_request_type()

View Source

Specs

v1_create_refund_request_type() :: binary()
Link to this type

v1_create_variation_request()

View Source

Specs

v1_create_variation_request() :: %{optional(:body) => v1_variation()}
Link to this type

v1_delete_category_request()

View Source

Specs

v1_delete_category_request() :: %{}
Link to this type

v1_delete_discount_request()

View Source

Specs

v1_delete_discount_request() :: %{}
Link to this type

v1_delete_fee_request()

View Source

Specs

v1_delete_fee_request() :: %{}
Link to this type

v1_delete_item_request()

View Source

Specs

v1_delete_item_request() :: %{}
Link to this type

v1_delete_modifier_list_request()

View Source

Specs

v1_delete_modifier_list_request() :: %{}
Link to this type

v1_delete_modifier_option_request()

View Source

Specs

v1_delete_modifier_option_request() :: %{}
Link to this type

v1_delete_page_cell_request()

View Source

Specs

v1_delete_page_cell_request() :: %{
  optional(:column) => binary(),
  optional(:row) => binary()
}
Link to this type

v1_delete_page_request()

View Source

Specs

v1_delete_page_request() :: %{}
Link to this type

v1_delete_timecard_request()

View Source

Specs

v1_delete_timecard_request() :: %{}
Link to this type

v1_delete_timecard_response()

View Source

Specs

v1_delete_timecard_response() :: %{}
Link to this type

v1_delete_variation_request()

View Source

Specs

v1_delete_variation_request() :: %{}

Specs

v1_discount() :: %{
  optional(:amount_money) => v1_money(),
  optional(:color) => binary(),
  optional(:discount_type) => binary(),
  optional(:id) => binary(),
  optional(:name) => binary(),
  optional(:pin_required) => boolean(),
  optional(:rate) => binary(),
  optional(:v2_id) => binary()
}

Specs

v1_discount_color() :: binary()
Link to this type

v1_discount_discount_type()

View Source

Specs

v1_discount_discount_type() :: binary()

Specs

v1_employee() :: %{
  optional(:authorized_location_ids) => [binary()],
  optional(:created_at) => binary(),
  optional(:email) => binary(),
  optional(:external_id) => binary(),
  :first_name => binary(),
  optional(:id) => binary(),
  :last_name => binary(),
  optional(:role_ids) => [binary()],
  optional(:status) => binary(),
  optional(:updated_at) => binary()
}

Specs

v1_employee_role() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  optional(:is_owner) => boolean(),
  :name => binary(),
  :permissions => [binary()],
  optional(:updated_at) => binary()
}
Link to this type

v1_employee_role_permissions()

View Source

Specs

v1_employee_role_permissions() :: binary()

Specs

v1_employee_status() :: binary()

Specs

v1_fee() :: %{
  optional(:adjustment_type) => binary(),
  optional(:applies_to_custom_amounts) => boolean(),
  optional(:calculation_phase) => binary(),
  optional(:enabled) => boolean(),
  optional(:id) => binary(),
  optional(:inclusion_type) => binary(),
  optional(:name) => binary(),
  optional(:rate) => binary(),
  optional(:type) => binary(),
  optional(:v2_id) => binary()
}
Link to this type

v1_fee_adjustment_type()

View Source

Specs

v1_fee_adjustment_type() :: binary()
Link to this type

v1_fee_calculation_phase()

View Source

Specs

v1_fee_calculation_phase() :: binary()
Link to this type

v1_fee_inclusion_type()

View Source

Specs

v1_fee_inclusion_type() :: binary()

Specs

v1_fee_type() :: binary()

Specs

v1_inventory_entry() :: %{
  optional(:quantity_on_hand) => number(),
  optional(:variation_id) => binary()
}

Specs

v1_item() :: %{
  optional(:abbreviation) => binary(),
  optional(:available_for_pickup) => boolean(),
  optional(:available_online) => boolean(),
  optional(:category) => v1_category(),
  optional(:category_id) => binary(),
  optional(:color) => binary(),
  optional(:description) => binary(),
  optional(:fees) => [v1_fee()],
  optional(:id) => binary(),
  optional(:master_image) => v1_item_image(),
  optional(:modifier_lists) => [v1_modifier_list()],
  optional(:name) => binary(),
  optional(:taxable) => boolean(),
  optional(:type) => binary(),
  optional(:v2_id) => binary(),
  optional(:variations) => [v1_variation()],
  optional(:visibility) => binary()
}

Specs

v1_item_color() :: binary()

Specs

v1_item_image() :: %{optional(:id) => binary(), optional(:url) => binary()}

Specs

v1_item_type() :: binary()

Specs

v1_item_visibility() :: binary()
Link to this type

v1_list_bank_accounts_request()

View Source

Specs

v1_list_bank_accounts_request() :: %{}
Link to this type

v1_list_bank_accounts_response()

View Source

Specs

v1_list_bank_accounts_response() :: %{optional(:items) => [v1_bank_account()]}
Link to this type

v1_list_cash_drawer_shifts_request()

View Source

Specs

v1_list_cash_drawer_shifts_request() :: %{
  optional(:begin_time) => binary(),
  optional(:end_time) => binary(),
  optional(:order) => binary()
}
Link to this type

v1_list_cash_drawer_shifts_response()

View Source

Specs

v1_list_cash_drawer_shifts_response() :: %{
  optional(:items) => [v1_cash_drawer_shift()]
}
Link to this type

v1_list_categories_request()

View Source

Specs

v1_list_categories_request() :: %{}
Link to this type

v1_list_categories_response()

View Source

Specs

v1_list_categories_response() :: %{optional(:items) => [v1_category()]}
Link to this type

v1_list_discounts_request()

View Source

Specs

v1_list_discounts_request() :: %{}
Link to this type

v1_list_discounts_response()

View Source

Specs

v1_list_discounts_response() :: %{optional(:items) => [v1_discount()]}
Link to this type

v1_list_employee_roles_request()

View Source

Specs

v1_list_employee_roles_request() :: %{
  optional(:batch_token) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary()
}
Link to this type

v1_list_employee_roles_response()

View Source

Specs

v1_list_employee_roles_response() :: %{optional(:items) => [v1_employee_role()]}
Link to this type

v1_list_employees_request()

View Source

Specs

v1_list_employees_request() :: %{
  optional(:batch_token) => binary(),
  optional(:begin_created_at) => binary(),
  optional(:begin_updated_at) => binary(),
  optional(:end_created_at) => binary(),
  optional(:end_updated_at) => binary(),
  optional(:external_id) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary(),
  optional(:status) => binary()
}
Link to this type

v1_list_employees_request_status()

View Source

Specs

v1_list_employees_request_status() :: binary()
Link to this type

v1_list_employees_response()

View Source

Specs

v1_list_employees_response() :: %{optional(:items) => [v1_employee()]}
Link to this type

v1_list_fees_request()

View Source

Specs

v1_list_fees_request() :: %{}
Link to this type

v1_list_fees_response()

View Source

Specs

v1_list_fees_response() :: %{optional(:items) => [v1_fee()]}
Link to this type

v1_list_inventory_request()

View Source

Specs

v1_list_inventory_request() :: %{
  optional(:batch_token) => binary(),
  optional(:limit) => integer()
}
Link to this type

v1_list_inventory_response()

View Source

Specs

v1_list_inventory_response() :: %{optional(:items) => [v1_inventory_entry()]}
Link to this type

v1_list_items_request()

View Source

Specs

v1_list_items_request() :: %{optional(:batch_token) => binary()}
Link to this type

v1_list_items_response()

View Source

Specs

v1_list_items_response() :: %{optional(:items) => [v1_item()]}
Link to this type

v1_list_locations_request()

View Source

Specs

v1_list_locations_request() :: %{}
Link to this type

v1_list_locations_response()

View Source

Specs

v1_list_locations_response() :: %{optional(:items) => [v1_merchant()]}
Link to this type

v1_list_modifier_lists_request()

View Source

Specs

v1_list_modifier_lists_request() :: %{}
Link to this type

v1_list_modifier_lists_response()

View Source

Specs

v1_list_modifier_lists_response() :: %{optional(:items) => [v1_modifier_list()]}
Link to this type

v1_list_orders_request()

View Source

Specs

v1_list_orders_request() :: %{
  optional(:batch_token) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary()
}
Link to this type

v1_list_orders_response()

View Source

Specs

v1_list_orders_response() :: %{optional(:items) => [v1_order()]}
Link to this type

v1_list_pages_request()

View Source

Specs

v1_list_pages_request() :: %{}
Link to this type

v1_list_pages_response()

View Source

Specs

v1_list_pages_response() :: %{optional(:items) => [v1_page()]}
Link to this type

v1_list_payments_request()

View Source

Specs

v1_list_payments_request() :: %{
  optional(:batch_token) => binary(),
  optional(:begin_time) => binary(),
  optional(:end_time) => binary(),
  optional(:include_partial) => boolean(),
  optional(:limit) => integer(),
  optional(:order) => binary()
}
Link to this type

v1_list_payments_response()

View Source

Specs

v1_list_payments_response() :: %{optional(:items) => [v1_payment()]}
Link to this type

v1_list_refunds_request()

View Source

Specs

v1_list_refunds_request() :: %{
  optional(:batch_token) => binary(),
  optional(:begin_time) => binary(),
  optional(:end_time) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary()
}
Link to this type

v1_list_refunds_response()

View Source

Specs

v1_list_refunds_response() :: %{optional(:items) => [v1_refund()]}
Link to this type

v1_list_settlements_request()

View Source

Specs

v1_list_settlements_request() :: %{
  optional(:batch_token) => binary(),
  optional(:begin_time) => binary(),
  optional(:end_time) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary(),
  optional(:status) => binary()
}
Link to this type

v1_list_settlements_request_status()

View Source

Specs

v1_list_settlements_request_status() :: binary()
Link to this type

v1_list_settlements_response()

View Source

Specs

v1_list_settlements_response() :: %{optional(:items) => [v1_settlement()]}
Link to this type

v1_list_timecard_events_request()

View Source

Specs

v1_list_timecard_events_request() :: %{}
Link to this type

v1_list_timecard_events_response()

View Source

Specs

v1_list_timecard_events_response() :: %{
  optional(:items) => [v1_timecard_event()]
}
Link to this type

v1_list_timecards_request()

View Source

Specs

v1_list_timecards_request() :: %{
  optional(:batch_token) => binary(),
  optional(:begin_clockin_time) => binary(),
  optional(:begin_clockout_time) => binary(),
  optional(:begin_updated_at) => binary(),
  optional(:deleted) => boolean(),
  optional(:employee_id) => binary(),
  optional(:end_clockin_time) => binary(),
  optional(:end_clockout_time) => binary(),
  optional(:end_updated_at) => binary(),
  optional(:limit) => integer(),
  optional(:order) => binary()
}
Link to this type

v1_list_timecards_response()

View Source

Specs

v1_list_timecards_response() :: %{optional(:items) => [v1_timecard()]}

Specs

v1_merchant() :: %{
  optional(:account_capabilities) => [binary()],
  optional(:account_type) => binary(),
  optional(:business_address) => address(),
  optional(:business_name) => binary(),
  optional(:business_phone) => v1_phone_number(),
  optional(:business_type) => binary(),
  optional(:country_code) => binary(),
  optional(:currency_code) => binary(),
  optional(:email) => binary(),
  optional(:id) => binary(),
  optional(:language_code) => binary(),
  optional(:location_details) => v1_merchant_location_details(),
  optional(:market_url) => binary(),
  optional(:name) => binary(),
  optional(:shipping_address) => address()
}
Link to this type

v1_merchant_account_type()

View Source

Specs

v1_merchant_account_type() :: binary()
Link to this type

v1_merchant_business_type()

View Source

Specs

v1_merchant_business_type() :: binary()
Link to this type

v1_merchant_location_details()

View Source

Specs

v1_merchant_location_details() :: %{optional(:nickname) => binary()}

Specs

v1_modifier_list() :: %{
  optional(:id) => binary(),
  optional(:modifier_options) => [v1_modifier_option()],
  optional(:name) => binary(),
  optional(:selection_type) => binary(),
  optional(:v2_id) => binary()
}
Link to this type

v1_modifier_list_selection_type()

View Source

Specs

v1_modifier_list_selection_type() :: binary()

Specs

v1_modifier_option() :: %{
  optional(:id) => binary(),
  optional(:modifier_list_id) => binary(),
  optional(:name) => binary(),
  optional(:on_by_default) => boolean(),
  optional(:ordinal) => integer(),
  optional(:price_money) => v1_money(),
  optional(:v2_id) => binary()
}

Specs

v1_money() :: %{
  optional(:amount) => integer(),
  optional(:currency_code) => binary()
}

Specs

v1_order() :: %{
  optional(:btc_price_satoshi) => number(),
  optional(:btc_receive_address) => binary(),
  optional(:buyer_email) => binary(),
  optional(:buyer_note) => binary(),
  optional(:canceled_note) => binary(),
  optional(:completed_note) => binary(),
  optional(:created_at) => binary(),
  optional(:errors) => [error()],
  optional(:expires_at) => binary(),
  optional(:id) => binary(),
  optional(:order_history) => [v1_order_history_entry()],
  optional(:payment_id) => binary(),
  optional(:promo_code) => binary(),
  optional(:recipient_name) => binary(),
  optional(:recipient_phone_number) => binary(),
  optional(:refunded_note) => binary(),
  optional(:shipping_address) => address(),
  optional(:state) => binary(),
  optional(:subtotal_money) => v1_money(),
  optional(:tender) => v1_tender(),
  optional(:total_discount_money) => v1_money(),
  optional(:total_price_money) => v1_money(),
  optional(:total_shipping_money) => v1_money(),
  optional(:total_tax_money) => v1_money(),
  optional(:updated_at) => binary()
}
Link to this type

v1_order_history_entry()

View Source

Specs

v1_order_history_entry() :: %{
  optional(:action) => binary(),
  optional(:created_at) => binary()
}
Link to this type

v1_order_history_entry_action()

View Source

Specs

v1_order_history_entry_action() :: binary()

Specs

v1_order_state() :: binary()

Specs

v1_page() :: %{
  optional(:cells) => [v1_page_cell()],
  optional(:id) => binary(),
  optional(:name) => binary(),
  optional(:page_index) => integer()
}

Specs

v1_page_cell() :: %{
  optional(:column) => integer(),
  optional(:object_id) => binary(),
  optional(:object_type) => binary(),
  optional(:page_id) => binary(),
  optional(:placeholder_type) => binary(),
  optional(:row) => integer()
}
Link to this type

v1_page_cell_object_type()

View Source

Specs

v1_page_cell_object_type() :: binary()
Link to this type

v1_page_cell_placeholder_type()

View Source

Specs

v1_page_cell_placeholder_type() :: binary()

Specs

v1_payment() :: %{
  optional(:additive_tax) => [v1_payment_tax()],
  optional(:additive_tax_money) => v1_money(),
  optional(:created_at) => binary(),
  optional(:creator_id) => binary(),
  optional(:device) => device(),
  optional(:discount_money) => v1_money(),
  optional(:gross_sales_money) => v1_money(),
  optional(:id) => binary(),
  optional(:inclusive_tax) => [v1_payment_tax()],
  optional(:inclusive_tax_money) => v1_money(),
  optional(:is_partial) => boolean(),
  optional(:itemizations) => [v1_payment_itemization()],
  optional(:merchant_id) => binary(),
  optional(:net_sales_money) => v1_money(),
  optional(:net_total_money) => v1_money(),
  optional(:payment_url) => binary(),
  optional(:processing_fee_money) => v1_money(),
  optional(:receipt_url) => binary(),
  optional(:refunded_money) => v1_money(),
  optional(:refunds) => [v1_refund()],
  optional(:surcharge_money) => v1_money(),
  optional(:surcharges) => [v1_payment_surcharge()],
  optional(:swedish_rounding_money) => v1_money(),
  optional(:tax_money) => v1_money(),
  optional(:tender) => [v1_tender()],
  optional(:tip_money) => v1_money(),
  optional(:total_collected_money) => v1_money()
}

Specs

v1_payment_discount() :: %{
  optional(:applied_money) => v1_money(),
  optional(:discount_id) => binary(),
  optional(:name) => binary()
}
Link to this type

v1_payment_item_detail()

View Source

Specs

v1_payment_item_detail() :: %{
  optional(:category_name) => binary(),
  optional(:item_id) => binary(),
  optional(:item_variation_id) => binary(),
  optional(:sku) => binary()
}
Link to this type

v1_payment_itemization()

View Source

Specs

v1_payment_itemization() :: %{
  optional(:discount_money) => v1_money(),
  optional(:discounts) => [v1_payment_discount()],
  optional(:gross_sales_money) => v1_money(),
  optional(:item_detail) => v1_payment_item_detail(),
  optional(:item_variation_name) => binary(),
  optional(:itemization_type) => binary(),
  optional(:modifiers) => [v1_payment_modifier()],
  optional(:name) => binary(),
  optional(:net_sales_money) => v1_money(),
  optional(:notes) => binary(),
  optional(:quantity) => number(),
  optional(:single_quantity_money) => v1_money(),
  optional(:taxes) => [v1_payment_tax()],
  optional(:total_money) => v1_money()
}
Link to this type

v1_payment_itemization_itemization_type()

View Source

Specs

v1_payment_itemization_itemization_type() :: binary()

Specs

v1_payment_modifier() :: %{
  optional(:applied_money) => v1_money(),
  optional(:modifier_option_id) => binary(),
  optional(:name) => binary()
}
Link to this type

v1_payment_surcharge()

View Source

Specs

v1_payment_surcharge() :: %{
  optional(:amount_money) => v1_money(),
  optional(:applied_money) => v1_money(),
  optional(:name) => binary(),
  optional(:rate) => binary(),
  optional(:surcharge_id) => binary(),
  optional(:taxable) => boolean(),
  optional(:taxes) => [v1_payment_tax()],
  optional(:type) => binary()
}
Link to this type

v1_payment_surcharge_type()

View Source

Specs

v1_payment_surcharge_type() :: binary()

Specs

v1_payment_tax() :: %{
  optional(:applied_money) => v1_money(),
  optional(:errors) => [error()],
  optional(:fee_id) => binary(),
  optional(:inclusion_type) => binary(),
  optional(:name) => binary(),
  optional(:rate) => binary()
}
Link to this type

v1_payment_tax_inclusion_type()

View Source

Specs

v1_payment_tax_inclusion_type() :: binary()

Specs

v1_phone_number() :: %{calling_code: binary(), number: binary()}

Specs

v1_refund() :: %{
  optional(:created_at) => binary(),
  optional(:is_exchange) => boolean(),
  optional(:merchant_id) => binary(),
  optional(:payment_id) => binary(),
  optional(:processed_at) => binary(),
  optional(:reason) => binary(),
  optional(:refunded_additive_tax) => [v1_payment_tax()],
  optional(:refunded_additive_tax_money) => v1_money(),
  optional(:refunded_discount_money) => v1_money(),
  optional(:refunded_inclusive_tax) => [v1_payment_tax()],
  optional(:refunded_inclusive_tax_money) => v1_money(),
  optional(:refunded_money) => v1_money(),
  optional(:refunded_processing_fee_money) => v1_money(),
  optional(:refunded_surcharge_money) => v1_money(),
  optional(:refunded_surcharges) => [v1_payment_surcharge()],
  optional(:refunded_tax_money) => v1_money(),
  optional(:refunded_tip_money) => v1_money(),
  optional(:type) => binary()
}

Specs

v1_refund_type() :: binary()
Link to this type

v1_remove_fee_request()

View Source

Specs

v1_remove_fee_request() :: %{}
Link to this type

v1_remove_modifier_list_request()

View Source

Specs

v1_remove_modifier_list_request() :: %{}
Link to this type

v1_retrieve_bank_account_request()

View Source

Specs

v1_retrieve_bank_account_request() :: %{}
Link to this type

v1_retrieve_business_request()

View Source

Specs

v1_retrieve_business_request() :: %{}
Link to this type

v1_retrieve_cash_drawer_shift_request()

View Source

Specs

v1_retrieve_cash_drawer_shift_request() :: %{}
Link to this type

v1_retrieve_employee_request()

View Source

Specs

v1_retrieve_employee_request() :: %{}
Link to this type

v1_retrieve_employee_role_request()

View Source

Specs

v1_retrieve_employee_role_request() :: %{}
Link to this type

v1_retrieve_item_request()

View Source

Specs

v1_retrieve_item_request() :: %{}
Link to this type

v1_retrieve_modifier_list_request()

View Source

Specs

v1_retrieve_modifier_list_request() :: %{}
Link to this type

v1_retrieve_order_request()

View Source

Specs

v1_retrieve_order_request() :: %{}
Link to this type

v1_retrieve_payment_request()

View Source

Specs

v1_retrieve_payment_request() :: %{}
Link to this type

v1_retrieve_settlement_request()

View Source

Specs

v1_retrieve_settlement_request() :: %{}
Link to this type

v1_retrieve_timecard_request()

View Source

Specs

v1_retrieve_timecard_request() :: %{}

Specs

v1_settlement() :: %{
  optional(:bank_account_id) => binary(),
  optional(:entries) => [v1_settlement_entry()],
  optional(:id) => binary(),
  optional(:initiated_at) => binary(),
  optional(:status) => binary(),
  optional(:total_money) => v1_money()
}

Specs

v1_settlement_entry() :: %{
  optional(:amount_money) => v1_money(),
  optional(:fee_money) => v1_money(),
  optional(:payment_id) => binary(),
  optional(:type) => binary()
}
Link to this type

v1_settlement_entry_type()

View Source

Specs

v1_settlement_entry_type() :: binary()
Link to this type

v1_settlement_status()

View Source

Specs

v1_settlement_status() :: binary()

Specs

v1_tender() :: %{
  optional(:card_brand) => binary(),
  optional(:change_back_money) => v1_money(),
  optional(:employee_id) => binary(),
  optional(:entry_method) => binary(),
  optional(:id) => binary(),
  optional(:is_exchange) => boolean(),
  optional(:name) => binary(),
  optional(:pan_suffix) => binary(),
  optional(:payment_note) => binary(),
  optional(:receipt_url) => binary(),
  optional(:refunded_money) => v1_money(),
  optional(:settled_at) => binary(),
  optional(:tendered_at) => binary(),
  optional(:tendered_money) => v1_money(),
  optional(:total_money) => v1_money(),
  optional(:type) => binary()
}
Link to this type

v1_tender_card_brand()

View Source

Specs

v1_tender_card_brand() :: binary()
Link to this type

v1_tender_entry_method()

View Source

Specs

v1_tender_entry_method() :: binary()

Specs

v1_tender_type() :: binary()

Specs

v1_timecard() :: %{
  optional(:clockin_location_id) => binary(),
  optional(:clockin_time) => binary(),
  optional(:clockout_location_id) => binary(),
  optional(:clockout_time) => binary(),
  optional(:created_at) => binary(),
  optional(:deleted) => boolean(),
  optional(:doubletime_seconds_worked) => number(),
  :employee_id => binary(),
  optional(:id) => binary(),
  optional(:overtime_seconds_worked) => number(),
  optional(:regular_seconds_worked) => number(),
  optional(:updated_at) => binary()
}

Specs

v1_timecard_event() :: %{
  optional(:clockin_time) => binary(),
  optional(:clockout_time) => binary(),
  optional(:created_at) => binary(),
  optional(:event_type) => binary(),
  optional(:id) => binary()
}
Link to this type

v1_timecard_event_event_type()

View Source

Specs

v1_timecard_event_event_type() :: binary()
Link to this type

v1_update_category_request()

View Source

Specs

v1_update_category_request() :: %{body: v1_category()}
Link to this type

v1_update_discount_request()

View Source

Specs

v1_update_discount_request() :: %{body: v1_discount()}
Link to this type

v1_update_employee_request()

View Source

Specs

v1_update_employee_request() :: %{body: v1_employee()}
Link to this type

v1_update_employee_role_request()

View Source

Specs

v1_update_employee_role_request() :: %{body: v1_employee_role()}
Link to this type

v1_update_fee_request()

View Source

Specs

v1_update_fee_request() :: %{body: v1_fee()}
Link to this type

v1_update_item_request()

View Source

Specs

v1_update_item_request() :: %{body: v1_item()}
Link to this type

v1_update_modifier_list_request()

View Source

Specs

v1_update_modifier_list_request() :: %{
  optional(:name) => binary(),
  optional(:selection_type) => binary()
}
Link to this type

v1_update_modifier_list_request_selection_type()

View Source

Specs

v1_update_modifier_list_request_selection_type() :: binary()
Link to this type

v1_update_modifier_option_request()

View Source

Specs

v1_update_modifier_option_request() :: %{body: v1_modifier_option()}
Link to this type

v1_update_order_request()

View Source

Specs

v1_update_order_request() :: %{
  :action => binary(),
  optional(:canceled_note) => binary(),
  optional(:completed_note) => binary(),
  optional(:refunded_note) => binary(),
  optional(:shipped_tracking_number) => binary()
}
Link to this type

v1_update_order_request_action()

View Source

Specs

v1_update_order_request_action() :: binary()
Link to this type

v1_update_page_cell_request()

View Source

Specs

v1_update_page_cell_request() :: %{body: v1_page_cell()}
Link to this type

v1_update_page_request()

View Source

Specs

v1_update_page_request() :: %{body: v1_page()}
Link to this type

v1_update_timecard_request()

View Source

Specs

v1_update_timecard_request() :: %{body: v1_timecard()}
Link to this type

v1_update_variation_request()

View Source

Specs

v1_update_variation_request() :: %{body: v1_variation()}

Specs

v1_variation() :: %{
  optional(:id) => binary(),
  optional(:inventory_alert_threshold) => integer(),
  optional(:inventory_alert_type) => binary(),
  optional(:item_id) => binary(),
  optional(:name) => binary(),
  optional(:ordinal) => integer(),
  optional(:price_money) => v1_money(),
  optional(:pricing_type) => binary(),
  optional(:sku) => binary(),
  optional(:track_inventory) => boolean(),
  optional(:user_data) => binary(),
  optional(:v2_id) => binary()
}
Link to this type

v1_variation_inventory_alert_type()

View Source

Specs

v1_variation_inventory_alert_type() :: binary()
Link to this type

v1_variation_pricing_type()

View Source

Specs

v1_variation_pricing_type() :: binary()
Link to this type

void_transaction_request()

View Source

Specs

void_transaction_request() :: %{}
Link to this type

void_transaction_response()

View Source

Specs

void_transaction_response() :: %{optional(:errors) => [error()]}

Specs

wage_setting() :: %{
  optional(:created_at) => binary(),
  optional(:is_overtime_exempt) => boolean(),
  optional(:job_assignments) => [job_assignment()],
  optional(:team_member_id) => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}

Specs

weekday() :: binary()

Specs

workweek_config() :: %{
  optional(:created_at) => binary(),
  optional(:id) => binary(),
  :start_of_day_local_time => binary(),
  :start_of_week => binary(),
  optional(:updated_at) => binary(),
  optional(:version) => integer()
}