{"files":{"SKILL.md":"---\nname: pos-api\ndescription: \"POS API skill. Use when working with POS for pos. Covers 46 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# POS API\nAPI version: 10.24.14\n\n## Auth\nApiKey Authorization in header\n\n## Base URL\nhttps://unify.apideck.com\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /pos/orders -- list orders\n3. POST /pos/orders -- create first order\n\n## Endpoints\n46 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Pos\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /pos/orders | List Orders |\n| POST | /pos/orders | Create Order |\n| GET | /pos/orders/{id} | Get Order |\n| PATCH | /pos/orders/{id} | Update Order |\n| DELETE | /pos/orders/{id} | Delete Order |\n| POST | /pos/orders/{id}/pay | Pay Order |\n| GET | /pos/payments | List Payments |\n| POST | /pos/payments | Create Payment |\n| GET | /pos/payments/{id} | Get Payment |\n| PATCH | /pos/payments/{id} | Update Payment |\n| DELETE | /pos/payments/{id} | Delete Payment |\n| GET | /pos/merchants | List Merchants |\n| POST | /pos/merchants | Create Merchant |\n| GET | /pos/merchants/{id} | Get Merchant |\n| PATCH | /pos/merchants/{id} | Update Merchant |\n| DELETE | /pos/merchants/{id} | Delete Merchant |\n| GET | /pos/locations | List Locations |\n| POST | /pos/locations | Create Location |\n| GET | /pos/locations/{id} | Get Location |\n| PATCH | /pos/locations/{id} | Update Location |\n| DELETE | /pos/locations/{id} | Delete Location |\n| GET | /pos/items | List Items |\n| POST | /pos/items | Create Item |\n| GET | /pos/items/{id} | Get Item |\n| PATCH | /pos/items/{id} | Update Item |\n| DELETE | /pos/items/{id} | Delete Item |\n| GET | /pos/modifiers | List Modifiers |\n| POST | /pos/modifiers | Create Modifier |\n| GET | /pos/modifiers/{id} | Get Modifier |\n| PATCH | /pos/modifiers/{id} | Update Modifier |\n| DELETE | /pos/modifiers/{id} | Delete Modifier |\n| GET | /pos/modifier-groups | List Modifier Groups |\n| POST | /pos/modifier-groups | Create Modifier Group |\n| GET | /pos/modifier-groups/{id} | Get Modifier Group |\n| PATCH | /pos/modifier-groups/{id} | Update Modifier Group |\n| DELETE | /pos/modifier-groups/{id} | Delete Modifier Group |\n| GET | /pos/order-types | List Order Types |\n| POST | /pos/order-types | Create Order Type |\n| GET | /pos/order-types/{id} | Get Order Type |\n| PATCH | /pos/order-types/{id} | Update Order Type |\n| DELETE | /pos/order-types/{id} | Delete Order Type |\n| GET | /pos/tenders | List Tenders |\n| POST | /pos/tenders | Create Tender |\n| GET | /pos/tenders/{id} | Get Tender |\n| PATCH | /pos/tenders/{id} | Update Tender |\n| DELETE | /pos/tenders/{id} | Delete Tender |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all orders?\" -> GET /pos/orders\n- \"Create a order?\" -> POST /pos/orders\n- \"Get order details?\" -> GET /pos/orders/{id}\n- \"Partially update a order?\" -> PATCH /pos/orders/{id}\n- \"Delete a order?\" -> DELETE /pos/orders/{id}\n- \"Create a pay?\" -> POST /pos/orders/{id}/pay\n- \"List all payments?\" -> GET /pos/payments\n- \"Create a payment?\" -> POST /pos/payments\n- \"Get payment details?\" -> GET /pos/payments/{id}\n- \"Partially update a payment?\" -> PATCH /pos/payments/{id}\n- \"Delete a payment?\" -> DELETE /pos/payments/{id}\n- \"List all merchants?\" -> GET /pos/merchants\n- \"Create a merchant?\" -> POST /pos/merchants\n- \"Get merchant details?\" -> GET /pos/merchants/{id}\n- \"Partially update a merchant?\" -> PATCH /pos/merchants/{id}\n- \"Delete a merchant?\" -> DELETE /pos/merchants/{id}\n- \"List all locations?\" -> GET /pos/locations\n- \"Create a location?\" -> POST /pos/locations\n- \"Get location details?\" -> GET /pos/locations/{id}\n- \"Partially update a location?\" -> PATCH /pos/locations/{id}\n- \"Delete a location?\" -> DELETE /pos/locations/{id}\n- \"List all items?\" -> GET /pos/items\n- \"Create a item?\" -> POST /pos/items\n- \"Get item details?\" -> GET /pos/items/{id}\n- \"Partially update a item?\" -> PATCH /pos/items/{id}\n- \"Delete a item?\" -> DELETE /pos/items/{id}\n- \"List all modifiers?\" -> GET /pos/modifiers\n- \"Create a modifier?\" -> POST /pos/modifiers\n- \"Get modifier details?\" -> GET /pos/modifiers/{id}\n- \"Partially update a modifier?\" -> PATCH /pos/modifiers/{id}\n- \"Delete a modifier?\" -> DELETE /pos/modifiers/{id}\n- \"List all modifier-groups?\" -> GET /pos/modifier-groups\n- \"Create a modifier-group?\" -> POST /pos/modifier-groups\n- \"Get modifier-group details?\" -> GET /pos/modifier-groups/{id}\n- \"Partially update a modifier-group?\" -> PATCH /pos/modifier-groups/{id}\n- \"Delete a modifier-group?\" -> DELETE /pos/modifier-groups/{id}\n- \"List all order-types?\" -> GET /pos/order-types\n- \"Create a order-type?\" -> POST /pos/order-types\n- \"Get order-type details?\" -> GET /pos/order-types/{id}\n- \"Partially update a order-type?\" -> PATCH /pos/order-types/{id}\n- \"Delete a order-type?\" -> DELETE /pos/order-types/{id}\n- \"List all tenders?\" -> GET /pos/tenders\n- \"Create a tender?\" -> POST /pos/tenders\n- \"Get tender details?\" -> GET /pos/tenders/{id}\n- \"Partially update a tender?\" -> PATCH /pos/tenders/{id}\n- \"Delete a tender?\" -> DELETE /pos/tenders/{id}\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api POS API\n@base https://unify.apideck.com\n@version 10.24.10\n@auth ApiKey Authorization in header\n@common_fields {x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application, raw: bool=false # Include raw response. Mostly used for debugging purposes, x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.}\n@endpoints 46\n@hint download_for_search\n@toc pos(46)\n\n@endpoint GET /pos/orders\n@desc List Orders\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, location_id: str # ID of the location., fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/orders\n@desc Create Order\n@required {merchant_id: str, location_id: str}\n@optional {id: str # A unique identifier for an object., idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., order_number: str, order_date: str(date), closed_date: str(date), reference_id: str # An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system., status: str(open/draft/delivered/delayed/voided/completed/hidden) # Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder](), payment_status: str(open/paid/refunded/credited/partially_paid/partially_refunded/unknown) # Is this order paid or not?, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., title: str, note: str # A note with information about this order, may be printed on the order receipt and displayed in apps, customer_id: str, employee_id: str, order_type_id: str, table: str, seat: str, total_amount: int, total_tip: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, refunded: bool, customers: [map{id: str, first_name: str, middle_name: str, last_name: str, phone_numbers: [map], emails: [map]}], fulfillments: [map{id: str, status: str, type: str, pickup_details: map, shipment_details: map}], line_items: [map{id: str, name: str, item: any, total_tax: int, total_discount: int, total_amount: int, quantity: num, unit_price: num, applied_taxes: [any], applied_discounts: [any], modifiers: [any]}], payments: [map{id: str, amount: int, currency: str}], service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}] # Optional service charges or gratuity tip applied to the order., refunds: [map{id: str, location_id: str, amount: int, currency: str, reason: str, status: str, tender_id: str, transaction_id: str}], taxes: [any], discounts: [map{id: str, product_id: str, name: str, type!: str, amount: int, currency: str, scope: str}], tenders: [map{id: str, name: str, type: str, note: str, amount: num, percentage: num, currency: str, total_amount: int, total_tip: int, total_processing_fee: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, buyer_tendered_cash_amount: int, change_back_cash_amount: int, card: map, card_status: str, card_entry_method: str, payment_id: str, location_id: str, transaction_id: str}], source: str(in-store/online/opt/api/kiosk/caller-id/google/invoice) # Source of order. Indicates the way that the order was placed., voided: bool, voided_at: str(date-time), custom_mappings: map # When custom mappings are configured on the resource, the result is included here., version: str, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/orders/{id}\n@desc Get Order\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, idempotency_key: str, order_number: str, order_date: str(date)?, closed_date: str(date)?, reference_id: str?, status: str, payment_status: str, currency: str?, title: str, note: str, merchant_id: str, customer_id: str, employee_id: str, location_id: str, order_type_id: str, table: str, seat: str, total_amount: int?, total_tip: int?, total_tax: int?, total_discount: int?, total_refund: int?, total_service_charge: int?, refunded: bool, customers: [map], fulfillments: [map], line_items: [map], payments: [map], service_charges: [map], refunds: [map], taxes: [any], discounts: [map], tenders: [map], source: str?, voided: bool, voided_at: str(date-time), custom_mappings: map?, version: str?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/orders/{id}\n@desc Update Order\n@required {id: str # ID of the record you are acting upon., merchant_id: str, location_id: str}\n@optional {id: str # A unique identifier for an object., idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., order_number: str, order_date: str(date), closed_date: str(date), reference_id: str # An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system., status: str(open/draft/delivered/delayed/voided/completed/hidden) # Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder](), payment_status: str(open/paid/refunded/credited/partially_paid/partially_refunded/unknown) # Is this order paid or not?, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., title: str, note: str # A note with information about this order, may be printed on the order receipt and displayed in apps, customer_id: str, employee_id: str, order_type_id: str, table: str, seat: str, total_amount: int, total_tip: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, refunded: bool, customers: [map{id: str, first_name: str, middle_name: str, last_name: str, phone_numbers: [map], emails: [map]}], fulfillments: [map{id: str, status: str, type: str, pickup_details: map, shipment_details: map}], line_items: [map{id: str, name: str, item: any, total_tax: int, total_discount: int, total_amount: int, quantity: num, unit_price: num, applied_taxes: [any], applied_discounts: [any], modifiers: [any]}], payments: [map{id: str, amount: int, currency: str}], service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}] # Optional service charges or gratuity tip applied to the order., refunds: [map{id: str, location_id: str, amount: int, currency: str, reason: str, status: str, tender_id: str, transaction_id: str}], taxes: [any], discounts: [map{id: str, product_id: str, name: str, type!: str, amount: int, currency: str, scope: str}], tenders: [map{id: str, name: str, type: str, note: str, amount: num, percentage: num, currency: str, total_amount: int, total_tip: int, total_processing_fee: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, buyer_tendered_cash_amount: int, change_back_cash_amount: int, card: map, card_status: str, card_entry_method: str, payment_id: str, location_id: str, transaction_id: str}], source: str(in-store/online/opt/api/kiosk/caller-id/google/invoice) # Source of order. Indicates the way that the order was placed., voided: bool, voided_at: str(date-time), custom_mappings: map # When custom mappings are configured on the resource, the result is included here., version: str, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/orders/{id}\n@desc Delete Order\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/orders/{id}/pay\n@desc Pay Order\n@required {id: str # ID of the record you are acting upon., merchant_id: str, location_id: str}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded., id: str # A unique identifier for an object., idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., order_number: str, order_date: str(date), closed_date: str(date), reference_id: str # An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system., status: str(open/draft/delivered/delayed/voided/completed/hidden) # Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder](), payment_status: str(open/paid/refunded/credited/partially_paid/partially_refunded/unknown) # Is this order paid or not?, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., title: str, note: str # A note with information about this order, may be printed on the order receipt and displayed in apps, customer_id: str, employee_id: str, order_type_id: str, table: str, seat: str, total_amount: int, total_tip: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, refunded: bool, customers: [map{id: str, first_name: str, middle_name: str, last_name: str, phone_numbers: [map], emails: [map]}], fulfillments: [map{id: str, status: str, type: str, pickup_details: map, shipment_details: map}], line_items: [map{id: str, name: str, item: any, total_tax: int, total_discount: int, total_amount: int, quantity: num, unit_price: num, applied_taxes: [any], applied_discounts: [any], modifiers: [any]}], payments: [map{id: str, amount: int, currency: str}], service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}] # Optional service charges or gratuity tip applied to the order., refunds: [map{id: str, location_id: str, amount: int, currency: str, reason: str, status: str, tender_id: str, transaction_id: str}], taxes: [any], discounts: [map{id: str, product_id: str, name: str, type!: str, amount: int, currency: str, scope: str}], tenders: [map{id: str, name: str, type: str, note: str, amount: num, percentage: num, currency: str, total_amount: int, total_tip: int, total_processing_fee: int, total_tax: int, total_discount: int, total_refund: int, total_service_charge: int, buyer_tendered_cash_amount: int, change_back_cash_amount: int, card: map, card_status: str, card_entry_method: str, payment_id: str, location_id: str, transaction_id: str}], source: str(in-store/online/opt/api/kiosk/caller-id/google/invoice) # Source of order. Indicates the way that the order was placed., voided: bool, voided_at: str(date-time), custom_mappings: map # When custom mappings are configured on the resource, the result is included here., version: str, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Orders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/payments\n@desc List Payments\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # PosPayments\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/payments\n@desc Create Payment\n@required {source_id: str # The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`., order_id: str, customer_id: str, tender_id: str, amount: num, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).}\n@optional {id: str # A unique identifier for an object., merchant_id: str, employee_id: str, location_id: str, device_id: str, external_payment_id: str, idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., tip: num, tax: num, total: num, app_fee: num # The amount the developer is taking as a fee for facilitating the payment on behalf of the seller., change_back_cash_amount: num, approved: num # The initial amount of money approved for this payment., refunded: num # The initial amount of money approved for this payment., processing_fees: [any], source: str(card/bank_account/wallet/bnpl/cash/external/other) # Source of this payment., status: str(approved/pending/completed/canceled/failed/other) # Status of this payment., cash: map{amount: any, charge_back_amount: any} # Cash details for this payment, card_details: map{card: map}, bank_account: map{bank_name: str, transfer_type: str, account_ownership_type: str, fingerprint: str, country: str, statement_description: str, ach_details: map} # Card details for this payment. This field is currently not available. Reach out to our team for more info., wallet: map{status: str} # Wallet details for this payment. This field is currently not available. Reach out to our team for more info., external_details: map{type!: str, source!: str, source_id: str, source_fee_amount: num} # Details about an external payment., service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}] # Optional service charges or gratuity tip applied to the order., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # PosPayments\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/payments/{id}\n@desc Get Payment\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, source_id: str, order_id: str, merchant_id: str, customer_id: str, employee_id: str, location_id: str, device_id: str, tender_id: str, external_payment_id: str, idempotency_key: str, amount: num, currency: str?, tip: num, tax: num, total: num, app_fee: num, change_back_cash_amount: num, approved: num, refunded: num, processing_fees: [any], source: str, status: str, cash: map{amount: any, charge_back_amount: any}, card_details: map{card: map?{id: str, bin: str?, card_brand: str?, card_type: str?, prepaid_type: str?, cardholder_name: str?, customer_id: str?, merchant_id: str, exp_month: int?, exp_year: int?, fingerprint: str?, last_4: str?, enabled: bool?, billing_address: map, reference_id: str?, version: str?}}, bank_account: map{bank_name: str, transfer_type: str, account_ownership_type: str, fingerprint: str, country: str?, statement_description: str, ach_details: map{routing_number: str, account_number_suffix: str, account_type: str}}, wallet: map{status: str}, external_details: map{type: str, source: str, source_id: str, source_fee_amount: num}, service_charges: [map], custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # PosPayments\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/payments/{id}\n@desc Update Payment\n@required {id: str # ID of the record you are acting upon., source_id: str # The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`., order_id: str, customer_id: str, tender_id: str, amount: num, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).}\n@optional {id: str # A unique identifier for an object., merchant_id: str, employee_id: str, location_id: str, device_id: str, external_payment_id: str, idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., tip: num, tax: num, total: num, app_fee: num # The amount the developer is taking as a fee for facilitating the payment on behalf of the seller., change_back_cash_amount: num, approved: num # The initial amount of money approved for this payment., refunded: num # The initial amount of money approved for this payment., processing_fees: [any], source: str(card/bank_account/wallet/bnpl/cash/external/other) # Source of this payment., status: str(approved/pending/completed/canceled/failed/other) # Status of this payment., cash: map{amount: any, charge_back_amount: any} # Cash details for this payment, card_details: map{card: map}, bank_account: map{bank_name: str, transfer_type: str, account_ownership_type: str, fingerprint: str, country: str, statement_description: str, ach_details: map} # Card details for this payment. This field is currently not available. Reach out to our team for more info., wallet: map{status: str} # Wallet details for this payment. This field is currently not available. Reach out to our team for more info., external_details: map{type!: str, source!: str, source_id: str, source_fee_amount: num} # Details about an external payment., service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}] # Optional service charges or gratuity tip applied to the order., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # PosPayments\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/payments/{id}\n@desc Delete Payment\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # PosPayments\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/merchants\n@desc List Merchants\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Merchants\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/merchants\n@desc Create Merchant\n@optional {id: str # A unique identifier for an object., name: str # The name of the merchant, address: map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, line5: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, notes: str, row_version: str}, owner_id: str, main_location_id: str # The main location ID of the merchant, status: str(active/inactive/other) # Status of this merchant., service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}], language: str # language code according to ISO 639-1. For the United States - EN, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Merchants\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/merchants/{id}\n@desc Get Merchant\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str?, address: map{id: str?, type: str?, string: str?, name: str?, line1: str?, line2: str?, line3: str?, line4: str?, line5: str?, street_number: str?, city: str?, state: str?, postal_code: str?, country: str?, latitude: str?, longitude: str?, county: str?, contact_name: str?, salutation: str?, phone_number: str?, fax: str?, email: str?, website: str?, notes: str?, row_version: str?}, owner_id: str, main_location_id: str?, status: str?, service_charges: [map], language: str?, currency: str?, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Merchants\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/merchants/{id}\n@desc Update Merchant\n@required {id: str # ID of the record you are acting upon.}\n@optional {id: str # A unique identifier for an object., name: str # The name of the merchant, address: map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, line5: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, notes: str, row_version: str}, owner_id: str, main_location_id: str # The main location ID of the merchant, status: str(active/inactive/other) # Status of this merchant., service_charges: [map{id: str, name: str, amount: num, percentage: num, currency: str, active: bool, type: str}], language: str # language code according to ISO 639-1. For the United States - EN, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Merchants\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/merchants/{id}\n@desc Delete Merchant\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Merchants\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/locations\n@desc List Locations\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Locations\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/locations\n@desc Create Location\n@optional {id: str # A unique identifier for an object., name: str # The name of the location, business_name: str # The business name of the location, address: map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, line5: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, notes: str, row_version: str}, status: str(active/inactive/other) # Status of this location., merchant_id: str, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Locations\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/locations/{id}\n@desc Get Location\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str?, business_name: str?, address: map{id: str?, type: str?, string: str?, name: str?, line1: str?, line2: str?, line3: str?, line4: str?, line5: str?, street_number: str?, city: str?, state: str?, postal_code: str?, country: str?, latitude: str?, longitude: str?, county: str?, contact_name: str?, salutation: str?, phone_number: str?, fax: str?, email: str?, website: str?, notes: str?, row_version: str?}, status: str?, merchant_id: str, currency: str?, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Locations\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/locations/{id}\n@desc Update Location\n@required {id: str # ID of the record you are acting upon.}\n@optional {id: str # A unique identifier for an object., name: str # The name of the location, business_name: str # The business name of the location, address: map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, line5: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, notes: str, row_version: str}, status: str(active/inactive/other) # Status of this location., merchant_id: str, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Locations\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/locations/{id}\n@desc Delete Location\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Locations\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/items\n@desc List Items\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Items\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/items\n@desc Create Item\n@required {name: str}\n@optional {id: str, idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., description: str, abbreviation: str, product_type: str(regular/other), price_amount: num, pricing_type: str(fixed/variable/per_unit/other), price_currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., cost: num, tax_ids: [str] # A list of Tax IDs for the product., is_revenue: bool # True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue., use_default_tax_rates: bool, absent_at_location_ids: [str] # A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated., present_at_all_locations: bool, available_for_pickup: bool, available_online: bool, sku: str # SKU of the item, code: str # Product code, e.g. UPC or EAN, categories: [any], options: [any] # List of options pertaining to this item's attribute variation, variations: [any], modifier_groups: [any], available: bool, hidden: bool, version: str # The user who last updated the object., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., deleted: bool # Flag to indicate if the object is deleted., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Items\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/items/{id}\n@desc Get Item\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, idempotency_key: str, name: str, description: str, abbreviation: str, product_type: str, price_amount: num, pricing_type: str, price_currency: str?, cost: num, tax_ids: [str], is_revenue: bool, use_default_tax_rates: bool, absent_at_location_ids: [str], present_at_all_locations: bool, available_for_pickup: bool, available_online: bool, sku: str, code: str, categories: [any], options: [any], variations: [any], modifier_groups: [any], available: bool?, hidden: bool?, version: str?, custom_mappings: map?, deleted: bool?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Items\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/items/{id}\n@desc Update Item\n@required {id: str # ID of the record you are acting upon., name: str}\n@optional {id: str, idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., description: str, abbreviation: str, product_type: str(regular/other), price_amount: num, pricing_type: str(fixed/variable/per_unit/other), price_currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., cost: num, tax_ids: [str] # A list of Tax IDs for the product., is_revenue: bool # True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue., use_default_tax_rates: bool, absent_at_location_ids: [str] # A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated., present_at_all_locations: bool, available_for_pickup: bool, available_online: bool, sku: str # SKU of the item, code: str # Product code, e.g. UPC or EAN, categories: [any], options: [any] # List of options pertaining to this item's attribute variation, variations: [any], modifier_groups: [any], available: bool, hidden: bool, version: str # The user who last updated the object., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., deleted: bool # Flag to indicate if the object is deleted., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Items\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/items/{id}\n@desc Delete Item\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Items\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/modifiers\n@desc List Modifiers\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Modifiers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/modifiers\n@desc Create Modifier\n@required {name: str, modifier_group_id: str}\n@optional {id: str # A unique identifier for an object., idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., alternate_name: str, price_amount: num, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., available: bool, custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Modifiers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/modifiers/{id}\n@desc Get Modifier\n@required {id: str # ID of the record you are acting upon.}\n@optional {filter: map # Apply filters, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, idempotency_key: str, name: str, alternate_name: str, price_amount: num, currency: str?, modifier_group_id: str, available: bool?, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Modifiers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/modifiers/{id}\n@desc Update Modifier\n@required {id: str # ID of the record you are acting upon., name: str, modifier_group_id: str}\n@optional {id: str # A unique identifier for an object., idempotency_key: str # A value you specify that uniquely identifies this request among requests you have sent., alternate_name: str, price_amount: num, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., available: bool, custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Modifiers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/modifiers/{id}\n@desc Delete Modifier\n@required {id: str # ID of the record you are acting upon.}\n@optional {filter: map # Apply filters}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Modifiers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/modifier-groups\n@desc List Modifier Groups\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # ModifierGroups\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/modifier-groups\n@desc Create Modifier Group\n@optional {id: str # A unique identifier for an object., name: str, alternate_name: str, minimum_required: int, maximum_allowed: int, selection_type: str(single/multiple), present_at_all_locations: bool, modifiers: [any], deleted: bool # Flag to indicate if the object is deleted., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., row_version: str # A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # ModifierGroups\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/modifier-groups/{id}\n@desc Get Modifier Group\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str, alternate_name: str, minimum_required: int, maximum_allowed: int, selection_type: str, present_at_all_locations: bool, modifiers: [any], deleted: bool?, custom_mappings: map?, row_version: str?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # ModifierGroups\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/modifier-groups/{id}\n@desc Update Modifier Group\n@required {id: str # ID of the record you are acting upon.}\n@optional {id: str # A unique identifier for an object., name: str, alternate_name: str, minimum_required: int, maximum_allowed: int, selection_type: str(single/multiple), present_at_all_locations: bool, modifiers: [any], deleted: bool # Flag to indicate if the object is deleted., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., row_version: str # A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # ModifierGroups\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/modifier-groups/{id}\n@desc Delete Modifier Group\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # ModifierGroups\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/order-types\n@desc List Order Types\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # OrderTypes\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/order-types\n@desc Create Order Type\n@optional {id: str # A unique identifier for an object., name: str, default: bool, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # OrderTypes\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/order-types/{id}\n@desc Get Order Type\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str, default: bool, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # OrderTypes\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/order-types/{id}\n@desc Update Order Type\n@required {id: str # ID of the record you are acting upon.}\n@optional {id: str # A unique identifier for an object., name: str, default: bool, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # OrderTypes\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/order-types/{id}\n@desc Delete Order Type\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # OrderTypes\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/tenders\n@desc List Tenders\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?} # Tenders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /pos/tenders\n@desc Create Tender\n@optional {id: str # A unique identifier for an object., key: str, label: str, active: bool, hidden: bool, editable: bool, opens_cash_drawer: bool=true # If this tender opens the cash drawer, allows_tipping: bool=true # Allow tipping on payment from tender, custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Tenders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /pos/tenders/{id}\n@desc Get Tender\n@required {id: str # ID of the record you are acting upon.}\n@optional {fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, key: str?, label: str?, active: bool?, hidden: bool?, editable: bool?, opens_cash_drawer: bool, allows_tipping: bool, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Tenders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /pos/tenders/{id}\n@desc Update Tender\n@required {id: str # ID of the record you are acting upon.}\n@optional {id: str # A unique identifier for an object., key: str, label: str, active: bool, hidden: bool, editable: bool, opens_cash_drawer: bool=true # If this tender opens the cash drawer, allows_tipping: bool=true # Allow tipping on payment from tender, custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Tenders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /pos/tenders/{id}\n@desc Delete Tender\n@required {id: str # ID of the record you are acting upon.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Tenders\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@end\n"}}