Developers
API changelog
Every change of the /v1 contract: new endpoints and fields, fixes and deprecations. A change inside /v1 never breaks a client that skips unknown fields.
Versioning policy
Within /v1 nothing is removed or renamed, and what worked keeps working. A breaking change comes as a new version, announced here in advance.
API versioning →Follow the changes
Subscribe to the Atom feed in your feed reader or team chat: a new entry appears there the day it is published.
Atom feed
Fixed
Lists return records whose reference a deletion cleared
When deleting a related record cleared a reference in a list record (a product tax_class_id after its tax class was deleted, a money account location_id after its location was deleted) or erased one of its nested rows (a supplier bill, goods receipt, supplier return or consignment settlement line, a product category), the record did not move in the change feed and did not emit .updated, so the integration copy kept the old value. Such a record now arrives in the next cursor sync and, for resources with a .updated event, as that event too. The feed will not replay changes made before this date: if your copy stores these references or nested rows, read the listed lists again once without a cursor.
Endpoints
- get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/paymentsList order payments changed since a given time - get
/refundsList order refunds changed since a given time: items and payment transactions - get
/customersList customers changed since a given time: contacts, marketing consent, addresses and groups; look up by phone, email and group - get
/locationsList the store locations available to the app - get
/categoriesList catalog categories changed since a given time - get
/productsList products: categories, options and media, without variants - get
/variantsList product variants: SKU, barcodes, prices and units - get
/modifier-groupsList modifier groups with options changed since the given moment - get
/recommendation-rulesList recommendation rules changed since a given time - get
/media-importsList photo downloads by URL changed since a given time: pending, downloaded or failed - get
/lotsProduct lots: number, expiry date and status, changed since a given moment - get
/location-transfersTransfers of goods between locations with their lines, changed since a given moment - get
/fiscal-documentsList fiscal documents changed since a given moment: invoices, credit and debit notes in every status - get
/money-accountsList the store money accounts with their current balance: cash, bank, acquiring, wallet - get
/money-categoriesList the money movement categories: the income and expense tree with system category codes - get
/pos-cash-movementsCash drawer journal: cash sales and refunds, pay-ins, pay-outs, safe drops, change and reversals - get
/gift-cardsGift cards: face value, balance and the store liability for each card - get
/gift-card-transactionsGift card activity: issue, redemption, refund to the card, adjustment, void, block and balance transfer - get
/supplier-billsSupplier bills: invoices, notes and debts for deliveries without an invoice, with tax and lines - get
/goods-receiptsGoods receipts: deliveries from suppliers with lines, delivery note prices and corrections - get
/supplier-returnsSupplier returns: goods shipped back to the supplier and the compensation for them - get
/consignment-settlementsConsignment settlements: consignment goods sold, written off at the store's cost and repriced over a period
- get
Changed
Supplier bill payment withholdings: jurisdiction and currency
In POST /v1/supplier-bills/{supplier_bill}/payments/out-of-band, a turnover or municipal withholding without jurisdiction is now rejected with 422: such a withholding did not reach any province return. The withholding amount is still in the bill currency and is deducted from the payment to the supplier. For a bill in another currency, tax-withholdings receives the amount and base converted to the store currency at the payment day rate; before, it received the bill currency number as is. Without a rate for that day, a payment with withholdings is rejected with 422.
Endpoints
Added
Group store transfers in the stock journal
The stock movement journal gained the reasons group_transfer_out (shipped to another store of the group), group_transfer_in (received from it) and group_transfer_return (a transfer shortage went back to the sender's stock), and the document type group_transfer — this store's copy of the transfer. Filtering by document_type=group_transfer returns the movements of one transfer. /v1 has no separate transfer resource.
Endpoints
Added
External POS document in orders
Orders got the external_fiscal_document field: the sale document in an external POS (FuDo, Poster) that issues it instead of us — the POS (issuer), the status pending or issued, and the number. The field comes with the fiscal:read scope; such orders have no fiscal documents. When the document appears or gets issued, the order moves in the feed and an order.updated event comes; historical orders get the field in a single backfill and pass through the feed again too. The orders.export bulk operation includes the field if the operation was created with the fiscal:read scope.
Endpoints
Added
Fiscal document writes
New scopes fiscal:write and fiscal:annul. With fiscal:write, POST /v1/orders/{order}/invoice issues the invoice of a closed sale, POST /v1/fiscal-documents/{document}/reissue reissues a document after a failure or a rejection by the tax authority (a rejected invoice with a corrected receptor or refresh_receptor), POST /v1/fiscal-documents/{document}/dismiss dismisses a rejected document. With fiscal:annul, POST /v1/fiscal-documents/{document}/annul annuls an issued invoice with a credit note and a reason. Issuing goes to the tax authority in the background: the response is 202 with the document, the outcome comes as fiscal_document.issued and fiscal_document.failed events. Commands that go to the tax authority require the Idempotency-Key header — without it, 422 idempotency_key_required. New refusals invoice_issue_refused, fiscal_document_reissue_refused, fiscal_document_dismiss_refused and fiscal_document_annul_refused. The fiscal document got the dismissal object, annulment got comment; annulment.reason is now order_cancelled, advance_applied or manual: the previous list described other reasons.
Endpoints
- post
/orders/{order}/invoiceIssue the invoice of a closed sale: issuing runs in the background, the outcome comes as an event - post
/fiscal-documents/{document}/reissueReissue a document after a failure or a rejection by the tax authority - post
/fiscal-documents/{document}/dismissDismiss a rejected document: it will not be issued - post
/fiscal-documents/{document}/annulAnnul an issued invoice with a credit note
- post
Added
Wholesale price lists
New scope orders:wholesale — wholesale terms, the dashboard permission to run wholesale; it includes orders:read, catalog:read and costs:read. Under it POST /v1/price-lists creates a wholesale list, DELETE /v1/price-lists/{price_list} deletes it under If-Match (a list assigned to customers — with the wholesale_price_list_buyers consent), and PATCH and the row commands write a wholesale list; for a wholesale list PATCH also changes name. POST /v1/customers/{customer}/wholesale-price-list assigns a wholesale list to a customer under its If-Match — it also needs customers:write. The list write commands accept either catalog:write or orders:wholesale, and the scope of the list kind is required — the insufficient_scope refusal names it; for an endpoint with several scopes the refusal lists them in accepted_scopes.
Endpoints
Added
Writing price lists
Under catalog:write a price list is written under If-Match of its version: PATCH /v1/price-lists/{price_list} changes its rule — adjustment_bp and rounding; the commands POST /v1/price-lists/{price_list}/items and …/items/remove set and remove fixed variant prices, …/modifier-items and …/modifier-items/remove — fixed modifier option surcharges, up to 1000 rows per request as one operation. The response is the list with its new version, and a batch sends a single price_list.updated event. A row in store money is written with price and compare_at_price, a row in the price list currency — with list_price and list_compare_at_price. An app manages a location list when all of its locations are accessible to it; wholesale lists are not written by these commands.
Endpoints
- patch
/price-lists/{price_list}Update a price list: adjustment and rounding, and the name of a wholesale list; a location list's rule changes prices at all its locations - post
/price-lists/{price_list}/itemsSet fixed variant prices in a price list in bulk - post
/price-lists/{price_list}/items/removeRemove fixed variant prices from a price list in bulk - post
/price-lists/{price_list}/modifier-itemsSet fixed modifier option surcharges in a price list in bulk - post
/price-lists/{price_list}/modifier-items/removeRemove fixed modifier option surcharges from a price list in bulk
- patch
Added
Price lists
Under catalog:read there are now price lists (GET /v1/price-lists) — location and wholesale lists with their adjustment_bp rule and rounding — their fixed variant prices (GET /v1/price-list-items) and fixed modifier option surcharges (GET /v1/price-list-modifier-items). A wholesale list prices from cost and is visible only with costs:read; a location list is visible to an app that can access at least one of its locations. Locations have a new price_list_id field; customers have wholesale_price_list_id and a customer feed filter by it. Changing a fixed price or surcharge bumps the list version. Events price_list.created, price_list.updated, price_list.deleted.
Endpoints
- get
/price-listsList the store's price lists: location and wholesale lists with their rule and rounding - get
/price-lists/{price_list}Get a price list - get
/price-list-itemsList fixed variant prices in price lists changed since a given moment - get
/price-list-items/{price_list_item}Get a fixed variant price in a price list - get
/price-list-modifier-itemsList fixed modifier option surcharges in price lists changed since a given moment - get
/price-list-modifier-items/{price_list_modifier_item}Get a fixed option surcharge in a price list - get
/locationsList the store locations available to the app - get
/customersList customers changed since a given time: contacts, marketing consent, addresses and groups; look up by phone, email and group - get
/customers/{customer}Get a customer
- get
Added
Customer groups
Under customers:read there are now customer groups (GET /v1/customer-groups) with name, description and activity, and the customer has a group_ids field and the customer feed a group_id filter. Under customers:write groups are created, changed under If-Match and deleted; deleting a group detaches it from discount rules and broadcasts, and a rule left without an audience is switched off. Customers are added to a group and removed from it with POST /v1/customer-groups/{customer_group}/members and …/members/remove. Membership does not move the customer version: a change moves the customer in the feed and sends customer.updated. Events customer_group.created, customer_group.updated, customer_group.deleted.
Endpoints
- get
/customer-groupsList the store's customer groups: name, description and whether they are active - get
/customer-groups/{customer_group}Get a customer group - post
/customer-groupsCreate a customer group - patch
/customer-groups/{customer_group}Change a group's name, description or activity - delete
/customer-groups/{customer_group}Delete a group: its memberships go with it, and discount rules and broadcasts stop targeting it - post
/customer-groups/{customer_group}/membersAdd customers to a group - post
/customer-groups/{customer_group}/members/removeRemove customers from a group - get
/customersList customers changed since a given time: contacts, marketing consent, addresses and groups; look up by phone, email and group - get
/customers/{customer}Get a customer
- get
Added
Tracking number of a delivery service without integration
POST /v1/orders/{order}/shipment/tracking under orders:write writes the tracking number, link and service name of an order shipped by a delivery service without integration; POST …/shipment/tracking/clear removes it. The number is in the order's shipment: carrier got the value courier_service, and shipment and previous_shipments got carrier_name — the service as the store named it. The customer sees the number on the order page and gets it in a message if the order is already with the service. New refusal shipment_tracking_refused.
Endpoints
- post
/orders/{order}/shipment/trackingWrite the tracking number of a delivery service without integration: number, link and service name - post
/orders/{order}/shipment/tracking/clearRemove a manually written tracking number - get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order
- post
Added
Issuing a shipment through the API
POST /v1/orders/{order}/shipment issues the shipment with the order's carrier under orders:write: the response is 202 with the order, the issue runs in the background and its outcome arrives with order.updated; when the shipment already exists the response is 200. shipment_attempt gained the queued and failed states and an error field with the reason code and text. New problems shipment_refused, shipment_in_progress and shipment_outcome_unknown.
Endpoints
- post
/orders/{order}/shipmentIssue the order's shipment with its carrier: the request runs in the background, the outcome shows in the order and arrives with order.updated - get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order
- post
Added
Variant price in the price list currency
Variants have list_price and list_price_currency: the price as the owner set it and its currency, when the store keeps its price list in a foreign currency. For such a variant price in store money is derived from the price list rate and is not accepted as input: set the price with list_price (the store price list currency or currency). null in list_price_currency means the price is set in store money, as before.
Endpoints
- get
/variantsList product variants: SKU, barcodes, prices and units - get
/variants/{variant}Get a product variant - get
/variants/by-external-id/{external_id}Get a product variant by its external ID - post
/variantsAdd a variant to a product - patch
/variants/{variant}Update a product variant - patch
/variants/by-external-id/{external_id}Create or update a variant by its external ID - get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID
- get
Added
Product ordering hours
Products have a new field sale_schedule — the week windows, in the store time zone, when the item can be ordered: a list of {days, from, to}, where days are ISO weekdays (1 is Monday) and from and to are “HH:MM”, with “24:00” only as an end; a window that ends before it starts runs past midnight and belongs to its start day. null means the item can always be ordered. It is not publication: outside the window the product stays visible and can go to the cart, and checkout checks the schedule against the order fulfilment time. The field can be written when creating, updating and upserting a product; null clears the schedule.
Endpoints
- get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID
- get
Added
Order carrier shipment
Orders now carry their carrier shipment: shipment — the carrier, the tracking number and page, the latest status from a closed set and the status history with the carrier's text; previous_shipments — shipments replaced by a re-issue; shipment_attempt — an issue in progress or with an unknown outcome. The shipping label is at GET /v1/orders/{order}/shipment/label, a PDF under orders:read and customers:read since it carries the recipient's details. New problems shipment_label_unavailable and carrier_unavailable. Polling the carrier without a new status no longer moves the order in the feed or sends order.updated.
Endpoints
- get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order - get
/orders/{order}/shipment/labelDownload the carrier label of the order's current shipment as a PDF; it carries the recipient's details, so customers:read is required too
- get
Added
Order discount breakdown
Orders now show what their discounts are made of: applied_discounts — the log of discounts on goods (where the discount came from, what it is for, rule name, promo code, the cashier's reason for a manual discount, the item for a single-item markdown, amount), delivery_discounts — delivery discounts, items[].discount_allocations — which log rows make up an item's discount. The sums match: Σ applied_discounts = discount, Σ delivery_discounts = delivery_discount, Σ of an item's allocations = its discount. A discount of the external POS comes as a row with source = external_pos. An order moves in the feed and sends order.updated also when its contents change without the order itself being written: the discount log or item costs.
Endpoints
Added
Location transfers and stock counts
Under inventory:read: location transfers (GET /v1/location-transfers) with their lines — variant, lot, quantity — and stock counts (GET /v1/stocktakes) with status, coverage and the blind-count flag. Stock count lines come in a feed of their own, GET /v1/stocktake-lines: expected, counted, variance, the adjustment applied and the location on-hand after posting; while a blind count is a draft, expected and variance are null. Stock movement documents of type location_transfer and stocktake are now readable through these resources. Events location_transfer.created, location_transfer.updated, stocktake.created, stocktake.status_changed, stocktake.updated.
Endpoints
- get
/location-transfersTransfers of goods between locations with their lines, changed since a given moment - get
/location-transfers/{location_transfer}Location transfer - get
/stocktakesStock counts: coverage, status and dates, changed since a given moment - get
/stocktakes/{stocktake}Stock count - get
/stocktake-linesStock count lines: expected, counted, variance and adjustment, changed since a given moment - get
/stocktake-lines/{stocktake_line}Stock count line
- get
Changed
Rate peg in the payment invoice
The rate mode tender.exchange_rate.mode got the value pegged: the store pegged the method currency to another currency (for example, 1 USDT = 1 USD), and the rate is that currency rate times the ratio. The new field tender.exchange_rate.peg {currency, rate} names the peg; null when the rate is not pegged. Prices set in the peg currency go into the invoice as they are.
Endpoints
Added
Stock movement journal and lots
Under inventory:read, the stock movement journal is now available (GET /v1/stock-movements) — the signed change to a location's physical stock, the stock after it, the reason, the stock ledger column and the primary document — along with lots (GET /v1/lots) with number, expiry date and status. Lines of goods receipts, supplier returns and consignment settlements now carry lot_id. Events stock_movement.created, stock_movement.updated, lot.created, lot.updated, lot.deleted.
Endpoints
- get
/stock-movementsStock movement journal: every change to a location's physical stock - get
/stock-movements/{stock_movement}Stock movement - get
/lotsProduct lots: number, expiry date and status, changed since a given moment - get
/lots/{lot}Product lot - get
/goods-receiptsGoods receipts: deliveries from suppliers with lines, delivery note prices and corrections - get
/goods-receipts/{goods_receipt}Goods receipt - get
/supplier-returnsSupplier returns: goods shipped back to the supplier and the compensation for them - get
/supplier-returns/{supplier_return}Supplier return - get
/consignment-settlementsConsignment settlements: consignment goods sold, written off at the store's cost and repriced over a period - get
/consignment-settlements/{consignment_settlement}Consignment settlement
- get
Added
Libro IVA books and the accountant package as files
Bulk operations got a third kind — a file. The libro_iva.export type builds the Libro IVA Digital books of a legal entity for a month: params are legal_entity_id, period as YYYY-MM and books (ventas, compras or both; purchases come with the import files). The accountant_package.export type builds the accountant package. It needs bulk:write and fiscal:read, Argentine tax ledger in the store and app access to all locations. The result is a ZIP with the same files as in the dashboard; it appears in full when completed, and until then GET …/result answers with the new 409 bulk_operation_result_unavailable. A refused build is failed with the code libro_iva_not_applicable or libro_iva_incomplete; for the latter, error.documents lists the documents and the reasons.
Endpoints
Added
Supplier bill payments outside the system
New scope procurement:pay — not granted by default; it includes procurement:read but neither write nor approval. POST /v1/supplier-bills/{supplier_bill}/payments/out-of-band under If-Match marks an approved bill as paid outside the system: the debt is settled without a store money account, and for a withholding-agent legal entity the withholdings list is required. The response is the created payment, 201 with Location. DELETE /{supplier_bill}/payments/{supplier_bill_payment} under If-Match cancels a money or out-of-band payment together with its withholdings; other kinds are removed by their own document — new refusal supplier_bill_payment_locked. Payments and cancellations arrive as the supplier_bill_payment.created and .deleted events, the amount due of the bill as supplier_bill.updated.
Endpoints
Added
Approving supplier bills for payment
New scope procurementSaleyarove — not granted by default; it includes procurement:read but not write. POST /v1/supplier-bills/{supplier_bill}/approve approves a posted bill for payment under If-Match: an unapproved bill cannot be paid, and an advance recorded on the bill's purchase order settles it right away. POST /{supplier_bill}/revoke-approval revokes the approval while the bill has no payments. A refusal due to the bill's state is supplier_bill_refused. Approval and its revocation arrive as the supplier_bill.updated event with the approved_at field.
Endpoints
Added
Variant piece net content
Variants got the net_content field — the net content of one piece {quantity, unit}: a 500 g pack, a 1000 ml bottle. Responses carry the effective measure: a pack of several units of another variant takes it from that variant, a prepacked piece from its own measure. It can be written when creating or updating a variant and a product with variants — only for a plain variant sold by piece; null clears it. Combo deals count packs into a «from 1 kg» slot by it, and storefront feeds show the price per kilogram.
Endpoints
- get
/variantsList product variants: SKU, barcodes, prices and units - get
/variants/{variant}Get a product variant - get
/variants/by-external-id/{external_id}Get a product variant by its external ID - post
/variantsAdd a variant to a product - patch
/variants/{variant}Update a product variant - patch
/variants/by-external-id/{external_id}Create or update a variant by its external ID - get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID
- get
Added
Writing supplier bills
Under procurement:write: a draft supplier bill (POST /v1/supplier-bills), changes to the draft under If-Match (PATCH /v1/supplier-bills/{supplier_bill}), deleting the draft (DELETE), posting with POST /{supplier_bill}/post and voiding with POST /{supplier_bill}/void. Fields match the response: the tax period as YYYY-MM, the rate as a string, taxes beyond VAT as additional_taxes, ARCA details in ar. The response and the input gain ar.import, the details of an import of goods or services. Posting may ask for the vendor_tax_id or close_returns consent. New refusal supplier_bill_refused: the command does not fit the state of the bill.
Endpoints
- post
/supplier-billsCreate a draft supplier bill - patch
/supplier-bills/{supplier_bill}Change a draft supplier bill - delete
/supplier-bills/{supplier_bill}Delete a draft supplier bill - post
/supplier-bills/{supplier_bill}/postPost a supplier bill: it enters payables and the purchase ledger - post
/supplier-bills/{supplier_bill}/voidVoid a supplier bill together with its payments and offsets
- post
Added
Writing purchase orders
Under procurement:write: a draft purchase order (POST /v1/purchase-orders), changes under If-Match (PATCH /v1/purchase-orders/{purchase_order}) — a draft in full, a placed order’s lines, date and note with a revision and a message to the supplier — draft deletion (DELETE) and the transitions POST /{purchase_order}/place, /cancel and /close. Line quantity and price unit are strings in the variant’s base unit, as in the response. Available to stores with procurement turned on, otherwise 403 capability_disabled. New problem purchase_order_refused: the command does not fit the order’s state.
Endpoints
- post
/purchase-ordersCreate a draft purchase order - patch
/purchase-orders/{purchase_order}Change a purchase order: a draft in full, a placed order’s lines, date and note with a revision - delete
/purchase-orders/{purchase_order}Delete a draft purchase order - post
/purchase-orders/{purchase_order}/placeMark a draft as placed with the supplier - post
/purchase-orders/{purchase_order}/cancelCancel a placed purchase order - post
/purchase-orders/{purchase_order}/closeClose a received purchase order
- post
Added
Modifiers
Modifier groups with options under catalog:read and catalog:write: the GET /v1/modifier-groups feed, a group by ID and by your system ID, create, update under If-Match, the upsert PATCH /v1/modifier-groups/by-external-id/{external_id} and archiving with the modifier_group_archive consent. Options are the group set: a row finds its option by id or external_id, an option missing from the set is archived. An update that lowers the selection minimum of products asks for the modifier_product_minimum consent. GET and PUT /v1/products/{product}/modifier-groups read and replace the product groups with the selection rule and option surcharges by variant; the product card has a new modifier_groups field. The variant recipe has a new option_recipes field — amounts of per-dish options. The store limit of groups is record_limit_reached.
Endpoints
- get
/modifier-groupsList modifier groups with options changed since the given moment - get
/modifier-groups/{group}Get a modifier group with its options - get
/modifier-groups/by-external-id/{external_id}Get a modifier group by external ID - post
/modifier-groupsCreate a modifier group with options - patch
/modifier-groups/{group}Update a modifier group and its option set - patch
/modifier-groups/by-external-id/{external_id}Create or update a modifier group by external ID - delete
/modifier-groups/{group}Archive a modifier group - get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID - put
/products/{product}/optionsReplace the product options and lay out its variants - get
/products/{product}/modifier-groupsGet the product modifier groups and their option surcharges by variant - put
/products/{product}/modifier-groupsReplace the product modifier groups and their option surcharges by variant - get
/variants/{variant}/recipeGet the recipe of a variant: components and the yield of a prep - put
/variants/{variant}/recipeReplace the recipe of a variant: components and the yield of a prep
- get
Added
Writing suppliers
New scope procurement:write. Create a supplier (POST /v1/suppliers), update it under If-Match (PATCH /v1/suppliers/{supplier}) and create or update it by its ID in your system (PATCH /v1/suppliers/by-external-id/{external_id}); find a supplier by that ID with GET /v1/suppliers/by-external-id/{external_id} under procurement:read. The writable fields are the fields of the response, except customer_id. Suppliers got the external_id field. New problem record_limit_reached: the store has reached the limit of records of this kind, which does not depend on the plan; POST /v1/suppliers and POST /v1/recommendation-rules return it.
Endpoints
- get
/suppliersStore suppliers: tax details and payment terms - get
/suppliers/{supplier}Supplier - get
/suppliers/by-external-id/{external_id}Supplier by its external ID - post
/suppliersCreate a supplier: tax details and payment terms - patch
/suppliers/{supplier}Update a supplier's tax details, payment terms and external ID - patch
/suppliers/by-external-id/{external_id}Create or update a supplier by its external ID - post
/recommendation-rulesCreate a recommendation rule - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now
- get
Added
Ingredients, preps and recipes
POST /v1/products and the upsert create ingredients and preps (type ingredient, prep) with stock_unit — the base unit of stock and recipes and the purchase package; every product response carries stock_unit. GET and PUT /v1/variants/{variant}/recipe read and replace the recipe of a variant: components with amounts in the unit of each component and the yield of a prep, under the product version. Labor norms, production steps, the consumption method and by-products stay in the store panel: the API does not touch them.
Endpoints
- get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID - put
/products/{product}/optionsReplace the product options and lay out its variants - get
/variants/{variant}/recipeGet the recipe of a variant: components and the yield of a prep - put
/variants/{variant}/recipeReplace the recipe of a variant: components and the yield of a prep
- get
Added
Withholdings and perceptions
Under fiscal:read: the register of withholdings and perceptions (GET /v1/tax-withholdings, filter direction) — tax withheld from the store (suffered: settlement provider, bank, customer acting as an agent) and tax the store withheld when paying a supplier (practiced): kind, tax and jurisdiction, amount, base and rate, counterparty, credit tax and month, certificate number, source and annulment. The certificate the store issues to the counterparty is GET /v1/tax-withholdings/{tax_withholding}/certificate (PDF). Customer account entries of kind withholding got tax_withholding_id — the certificate in the register. New events: tax_withholding.created, tax_withholding.updated, tax_withholding.annulled and tax_withholding.deleted.
Endpoints
- get
/tax-withholdingsList withholdings and perceptions changed since a given moment: tax withheld from the store, to credit, and tax the store withheld, to remit - get
/tax-withholdings/{tax_withholding}Get a withholding or perception - get
/tax-withholdings/{tax_withholding}/certificateDownload the PDF withholding certificate the store issues to the counterparty - get
/customer-account-entriesCustomer account entries: sales on account, payments, returns, write-offs, offsets, withholdings and reversals - get
/customer-account-entries/{customer_account_entry}Customer account entry - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Consignment settlements
Under procurement:read: consignment settlements (GET /v1/consignment-settlements, filter supplier_id) — what was sold from consignment goods over a period, written off at the store's cost and charged extra for a price fixed by a goods receipt correction: section subtotals and lines with the variant, the goods receipt, the quantity in the variant base unit and the supply price, in the settlement currency and in store currency. Supplier bills already point to the settlement with consignment_settlement_id. New events: consignment_settlement.created, consignment_settlement.updated, consignment_settlement.posted and consignment_settlement.voided.
Endpoints
- get
/consignment-settlementsConsignment settlements: consignment goods sold, written off at the store's cost and repriced over a period - get
/consignment-settlements/{consignment_settlement}Consignment settlement - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Purchase orders, goods receipts and supplier returns
Under procurement:read: purchase orders (GET /v1/purchase-orders, filter supplier_id) with lines of ordered, supplier-confirmed and received quantities; goods receipts (GET /v1/goods-receipts, filters supplier_id and purchase_order_id) with lines carrying the delivery note price, the price in store currency and the cost after tax, and before-and-after corrections; supplier returns (GET /v1/supplier-returns, filters supplier_id and goods_receipt_id) with lines, expected and received compensation and corrections. Quantities are strings in the variant base unit. Supplier bills gained goods_receipt_ids, purchase_order_ids and supplier_return_ids. New events: purchase_order.created, purchase_order.updated, purchase_order.status_changed, purchase_order.deleted, goods_receipt.created, goods_receipt.updated, goods_receipt.voided, supplier_return.created, supplier_return.updated, supplier_return.status_changed and supplier_return.deleted.
Endpoints
- get
/purchase-ordersPurchase orders: ordered, confirmed by the supplier and received, by line - get
/purchase-orders/{purchase_order}Purchase order - get
/goods-receiptsGoods receipts: deliveries from suppliers with lines, delivery note prices and corrections - get
/goods-receipts/{goods_receipt}Goods receipt - get
/supplier-returnsSupplier returns: goods shipped back to the supplier and the compensation for them - get
/supplier-returns/{supplier_return}Supplier return - get
/supplier-billsSupplier bills: invoices, notes and debts for deliveries without an invoice, with tax and lines - get
/supplier-bills/{supplier_bill}Supplier bill - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Supplier balances, statements and offsets
Under procurement:read: supplier balance (GET /v1/suppliers/{id}/balance) — seven debt components, overdue aging and the total; supplier statement (GET /v1/suppliers/{id}/statement) — opening and closing balance for the period and lines with a running balance; both accept legal_entity_id. Offsets (GET /v1/settlement-offsets), their lines as a separate feed (GET /v1/settlement-offset-lines) and offset agreements (GET /v1/settlement-agreements). Supplier bills gain paid_total and outstanding in the document currency. Customer account entries gain settlement_offset_id. A supplier's customer_id now requires customers:read. New events: settlement_agreement.created, settlement_agreement.updated, settlement_agreement.deleted, settlement_offset.created, settlement_offset.updated and settlement_offset.voided.
Endpoints
- get
/suppliers/{supplier}/balanceSupplier balance: what the store owes right now, by component and due date - get
/suppliers/{supplier}/statementSupplier statement for a period: opening and closing balance, lines with a running balance - get
/suppliersStore suppliers: tax details and payment terms - get
/suppliers/{supplier}Supplier - get
/settlement-agreementsOffset agreements: parties, kind, contract details, term and schedule - get
/settlement-agreements/{settlement_agreement}Offset agreement - get
/settlement-offsetsOffsets: mutual debts of a customer and a supplier settled by an offset document - get
/settlement-offsets/{settlement_offset}Offset - get
/settlement-offset-linesOffset lines: customer debts and supplier bills that were offset - get
/settlement-offset-lines/{settlement_offset_line}Offset line - get
/supplier-billsSupplier bills: invoices, notes and debts for deliveries without an invoice, with tax and lines - get
/supplier-bills/{supplier_bill}Supplier bill - get
/customer-account-entriesCustomer account entries: sales on account, payments, returns, write-offs, offsets, withholdings and reversals - get
/customer-account-entries/{customer_account_entry}Customer account entry - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Suppliers and supplier bills
New scope procurement:read. Suppliers (GET /v1/suppliers) — tax details and payment terms, without the contact person or notes. Supplier bills (GET /v1/supplier-bills, supplier_id filter) — invoices, notes and debts for deliveries without an invoice (fiscal: false), with VAT as the shared tax line, perceptions and withholdings in the additional_taxes list, lines and ARCA details in ar. Bill payments (GET /v1/supplier-bill-payments, supplier_bill_id filter) — by money, offset, credit note, purchase order advance, journal expense or outside the system. New events: supplier.created, supplier.updated, supplier.deleted, supplier_bill.created, supplier_bill.updated, supplier_bill.posted, supplier_bill.voided, supplier_bill.deleted, supplier_bill_payment.created, supplier_bill_payment.updated and supplier_bill_payment.deleted.
Endpoints
- get
/suppliersStore suppliers: tax details and payment terms - get
/suppliers/{supplier}Supplier - get
/supplier-billsSupplier bills: invoices, notes and debts for deliveries without an invoice, with tax and lines - get
/supplier-bills/{supplier_bill}Supplier bill - get
/supplier-bill-paymentsSupplier bill payments: money, offset, credit note, advance, journal expense or paid outside the system - get
/supplier-bill-payments/{supplier_bill_payment}Supplier bill payment - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Money journal writes and debt payments
New scope finance:write. Manual income or expense (POST /v1/money-transactions), updating and deleting a transaction under If-Match: a transaction with a source document changes only its category, counterparty and description, anything else is 409 money_transaction_locked. Account-currency amounts are decimal strings, extra decimal places are 422. Transfers between accounts: POST, GET, PATCH and DELETE /v1/money-transfers. Bulk operations money_transactions.create and money_transactions.update post and categorize the journal in bulk. A customer debt payment with money already received: POST /v1/customer-accounts/{customer_account}/payments, with withholding certificates. Customer account entries get the order_id filter: debt payment entries link to the debt payment order, not to a payment.
Endpoints
- post
/money-transactionsRecord manual income or expense on a money account - patch
/money-transactions/{transaction}Update a money transaction: only the category, counterparty and description of a transaction with a source document - delete
/money-transactions/{transaction}Delete a manual money transaction and restore the account balance - post
/money-transfersTransfer money between accounts, with or without a fee - get
/money-transfers/{money_transfer}Get a transfer between money accounts - patch
/money-transfers/{money_transfer}Update a whole transfer in place: accounts, amounts, fee, date and description - delete
/money-transfers/{money_transfer}Delete a transfer with all its legs - post
/customer-accounts/{customer_account}/paymentsRecord a customer debt payment with money already received: an entry in the receivables book with withholding certificates - get
/customer-account-entriesCustomer account entries: sales on account, payments, returns, write-offs, offsets, withholdings and reversals - post
/bulk-operationsStart a bulk operation from an upload or an input address, a feed export or a file build - get
/bulk-operationsList the app bulk operations changed since a given time: progress and outcomes - get
/bulk-operations/{operation}Get a bulk operation
- post
Added
Customer receivables book
Under finance:read, customer accounts are now available (GET /v1/customer-accounts) with a balance equal to the sum of the account entries, a credit limit (null means no limit) and payment terms; plus the account entries (GET /v1/customer-account-entries, filters customer_account_id and payment_id) with a signed amount, the due date of each charge and links to the order, payment and refund; and a statement for a period (GET /v1/customer-accounts/{customer_account}/statement) with a running balance and open debts with due dates. The customer_id and the staff note about the customer require customers:read. New events: customer_account.created, customer_account.updated, customer_account_entry.created and customer_account_entry.updated, sent when a customer merge moves an entry to the remaining customer account.
Endpoints
- get
/customer-accountsCustomer accounts in the receivables book: balance, credit limit and payment terms - get
/customer-accounts/{customer_account}Customer account - get
/customer-accounts/{customer_account}/statementCustomer account statement for a period: opening and closing balance, entries with a running balance, and open debts with due dates - get
/customer-account-entriesCustomer account entries: sales on account, payments, returns, write-offs, offsets, withholdings and reversals - get
/customer-account-entries/{customer_account_entry}Customer account entry - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Gift cards and their activity
Under finance:read, gift cards are now available (GET /v1/gift-cards) with face value, balance and outstanding, the store liability for the card: 0 for an unpaid card, equal to the balance for a blocked or expired one; plus the gift card activity (GET /v1/gift-card-transactions, filters gift_card_id and payment_id) with a signed amount and the balance after each entry. The card owner customer_id requires customers:read. New events: gift_card.created, gift_card.updated and gift_card_transaction.created.
Endpoints
- get
/gift-cardsGift cards: face value, balance and the store liability for each card - get
/gift-cards/{card}Gift card - get
/gift-card-transactionsGift card activity: issue, redemption, refund to the card, adjustment, void, block and balance transfer - get
/gift-card-transactions/{entry}Gift card activity entry - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Register shifts and the cash drawer journal
finance:read now covers register shifts (GET /v1/pos-shifts) with drawer reconciliation for each currency — opening float, expected, counted, difference and float left for the next shift — the cash drawer journal (GET /v1/pos-cash-movements, shift_id filter) and pay-in and pay-out reasons (GET /v1/pos-cash-reasons). Payments and refunds get a pos_shift_id field and filter: the shift that took the money, used to reconcile its sales. New events: pos_shift.opened, pos_shift.closed, pos_shift.updated and pos_cash_movement.created.
Endpoints
- get
/pos-shiftsRegister shifts changed since a given moment: cash drawer reconciliation for each currency - get
/pos-shifts/{shift}Register shift - get
/pos-cash-movementsCash drawer journal: cash sales and refunds, pay-ins, pay-outs, safe drops, change and reversals - get
/pos-cash-movements/{movement}Cash drawer movement - get
/pos-cash-reasonsPay-in and pay-out reasons with their money journal category - get
/paymentsList order payments changed since a given time - get
/payments/{payment}Get an order payment - post
/payments/{payment}/confirmConfirm that the money of a pending invoice was received - get
/refundsList order refunds changed since a given time: items and payment transactions - get
/refunds/{refund}Get an order refund - post
/orders/{order}/refundsRefund order items and delivery: money goes back by the payment methods, goods go back to stock - post
/refunds/{refund}/confirmConfirm that the refund money was paid back outside the system - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Accounting day rate
The new GET /v1/exchange-rates/{currency} operation under finance:read returns the accounting day rate on a date — the rate the money journal uses to convert transactions on an account in that currency into the store currency: as a decimal string, with the day it was fixed (rate_date) and the market rate source from the store rule.
Endpoints
Added
Money journal: accounts, categories and transactions
The new finance:read scope opens the store money accounts with their balance in the account currency, movement categories with system category codes and the transaction journal — with the posting amount in the store currency and in the account currency, the accounting date, the posting record (source) and the primary document (document); transfer legs share transfer_id. New events: money_transaction.created, money_transaction.updated and money_transaction.deleted.
Endpoints
- get
/money-accountsList the store money accounts with their current balance: cash, bank, acquiring, wallet - get
/money-accounts/{account}Get a money account - get
/money-categoriesList the money movement categories: the income and expense tree with system category codes - get
/money-transactionsList money transactions changed since a given moment: account income and expenses with their source and primary document - get
/money-transactions/{transaction}Get a money transaction - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Provider fee and withheld tax of a payment
A payment gets provider_fee_amount and provider_withheld_tax_amount — the payment provider fee and the tax it withheld as an agent — and the shares the provider gave back when the buyer was refunded: refunded_provider_fee_amount and refunded_provider_withheld_tax_amount.
Endpoints
- get
/paymentsList order payments changed since a given time - get
/payments/{payment}Get an order payment - post
/payments/{payment}/confirmConfirm that the money of a pending invoice was received - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Payment money, the legal entity of a sale, and payment and refund events
A payment gets tender — payment in a foreign currency with the rate, its mode, source, market base and store markup — received_asset (the coin that actually arrived) and legal_entity_id; an order gets legal_entity_id. New events: payment.created, payment.succeeded, payment.status_changed, payment.updated, refund.completed, refund.status_changed and refund.updated.
Endpoints
- get
/paymentsList order payments changed since a given time - get
/payments/{payment}Get an order payment - post
/payments/{payment}/confirmConfirm that the money of a pending invoice was received - get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order - post
/orders/{order}/cancelCancel an order - post
/orders/{order}/statusMove an order to another status of the store - post
/draft-orders/{draft}/completePlace the order from a draft: invoice the customer or record the payment as received - get
/bulk-operations/{operation}/resultGet the result of a bulk operation — NDJSON, a line per input line or per exported item, or the ZIP of a file operation; resume with Range - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Legal entities, fiscal documents and tax periods
The new fiscal:read scope opens the store legal entities, fiscal documents in every status — with the tax authorized by the tax authority, the accounting date, ARCA details and the PDF — and the tax periods of legal entities in Argentine stores. The document recipient requires customers:read. New events: fiscal_document.created, fiscal_document.updated, fiscal_document.issued, fiscal_document.failed, fiscal_document.annulled and tax_period.status_changed.
Endpoints
- get
/legal-entitiesList the store legal entities: issuers of fiscal documents and owners of tax periods - get
/fiscal-documentsList fiscal documents changed since a given moment: invoices, credit and debit notes in every status - get
/fiscal-documents/{document}Get a fiscal document - get
/fiscal-documents/{document}/pdfDownload the PDF of a fiscal document, the same file the customer receives - get
/tax-periodsList the tax periods of legal entities: which months are closed and final - get
/eventsList store events of the last 30 days: what changed in orders, payments, refunds, fiscal documents, tax periods, products, stock and customers, with the record as it is now - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status
- get
Added
Tax of the sale and cost of order items
Orders get tax_lines, delivery_tax_lines and tax_lines of each item, refunds get tax_lines: the tax of the sale by the classification of the products, in one TaxLine form. With costs:read, order items get cost_amount and cost_basis.
Endpoints
- get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order - post
/orders/{order}/cancelCancel an order - post
/orders/{order}/statusMove an order to another status of the store - post
/draft-orders/{draft}/completePlace the order from a draft: invoice the customer or record the payment as received - get
/refundsList order refunds changed since a given time: items and payment transactions - get
/refunds/{refund}Get an order refund - post
/orders/{order}/refundsRefund order items and delivery: money goes back by the payment methods, goods go back to stock - post
/refunds/{refund}/confirmConfirm that the refund money was paid back outside the system - get
/bulk-operations/{operation}/resultGet the result of a bulk operation — NDJSON, a line per input line or per exported item, or the ZIP of a file operation; resume with Range
- get
Added
Tax classes of products
New endpoint /v1/tax-classes lists the tax classes of the store: the kind of tax (taxed, exempt, untaxed) and the rate in basis points. Products have a new field tax_class_id, readable and writable on create, update and upsert; null means the default class of the store. Before, a product created through the API always got the default class.
Endpoints
- get
/tax-classesList the tax classes of the store: the kind and rate of tax a product sells with - get
/productsList products: categories, options and media, without variants - get
/products/{product}Get a product - get
/products/by-external-id/{external_id}Get a product by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID - put
/products/{product}/optionsReplace the product options and lay out its variants
- get
Added
Marketing consent per channel
Customers have a new field marketing_consents — marketing consent per channel (email, telegram, whatsapp, instagram): a row for each channel where the customer explicitly agreed (subscribed) or refused (unsubscribed), with the moment of the latest explicit consent. A refusal on one channel no longer stops marketing on the others. On WhatsApp the store sends marketing only with subscribed, in any consent mode.
Endpoints
- get
/customersList customers changed since a given time: contacts, marketing consent, addresses and groups; look up by phone, email and group - get
/customers/{customer}Get a customer - get
/customers/by-external-id/{external_id}Get a customer by its external ID - post
/customersCreate a customer: a name and at least one contact - patch
/customers/{customer}Update a customer's name, language and external ID - patch
/customers/by-external-id/{external_id}Create or update a customer by its external ID
- get
Deprecated
accepts_marketing and marketing_consent_at are deprecated
The customer fields accepts_marketing and marketing_consent_at are deprecated and now mean email marketing consent. Per-channel consent is in marketing_consents. The fields keep working as long as /v1 does.
Endpoints
- get
/customersList customers changed since a given time: contacts, marketing consent, addresses and groups; look up by phone, email and group - get
/customers/{customer}Get a customer - get
/customers/by-external-id/{external_id}Get a customer by its external ID - post
/customersCreate a customer: a name and at least one contact - patch
/customers/{customer}Update a customer's name, language and external ID - patch
/customers/by-external-id/{external_id}Create or update a customer by its external ID
- get
Added
Membership renewal invoice
Orders get a new system cancellation reason cancel_reason = membership_renewal_void: a membership renewal invoice was voided because the membership was cancelled or ended unpaid. No money was taken on such an invoice.
Endpoints
Added
Total currency when completing a draft
Completing a draft accepts the optional currency field — the currency in which the app read the total. A store without orders may change its currency, and the total would match as a number in another currency; such a completion now gets 422 and no order is created.
Endpoints
Added
Visit package expiry
Visits of a package whose term is over become a sale of the day — an order paid with the service_package method. Extending the term cancels that sale by the system: the order gets the cancel reason service_package_term_extended and the visits go back to the package.
Endpoints
Added
Error types for each endpoint
Each endpoint in the specification now has an x-problem-types field with the error types it returns: its own errors and those that follow from how it works (idempotency key, version in If-Match, feed cursor, result range, deletion, consent to side effects). Common errors such as token, access, input validation, rate limit and server failures can come from any endpoint, and the document-level x-problem-types catalog still lists them. The stocktake_location_occupied type was removed from the catalog because no endpoint returned it. Endpoints that respond with a conflict without an idempotency key now describe the 409 response.
Changed
Limit on rejected requests
Requests rejected on entry — 401 and the 403 of an address that is not allowed or a plan without the API — are now counted per address. Above the rejected_requests_per_minute limit the address gets 429 too_many_requests with policy set to rejected and a Retry-After header until the minute ends. Requests with a valid token are not counted and are never rejected by this limit.
Added
Visits from packages
Payment method service_package — a visit redeemed from the client’s visit package: the order line was paid by a visit bought earlier with the package. The store received that money when it sold the package, so this payment never reaches the till or the accounts, while the visit becomes order revenue now. Refunding such a line returns the visit to the package — a refund transaction with target service_package that moves no money.
Endpoints
- get
/paymentsList order payments changed since a given time - get
/payments/{payment}Get an order payment - get
/refundsList order refunds changed since a given time: items and payment transactions - get
/refunds/{refund}Get an order refund - post
/orders/{order}/refundsRefund order items and delivery: money goes back by the payment methods, goods go back to stock - post
/orders/{order}/refunds/calculateCalculate an order refund and what is left to refund, without writing anything - get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order - post
/draft-orders/{draft}/completePlace the order from a draft: invoice the customer or record the payment as received
- get
Added
Visit packages
Product type service_package — a visit package: a set of service visits the store sells in advance. Orders now have a service_package_issue_amount field — the total of visit packages sold in the order. A package is the store’s obligation to provide visits, not revenue: revenue comes when a visit is redeemed from the package. Subtract the field from the total together with gift_card_issue_amount, reservation_deposit_amount and account_payment_amount.
Endpoints
- get
/ordersList orders changed since a given time: items, totals, the order status and the payment status - get
/orders/{order}Get an order - post
/orders/{order}/statusMove an order to another status of the store - post
/orders/{order}/cancelCancel an order - post
/draft-orders/{draft}/completePlace the order from a draft: invoice the customer or record the payment as received - get
/bulk-operations/{operation}/resultGet the result of a bulk operation — NDJSON, a line per input line or per exported item, or the ZIP of a file operation; resume with Range - get
/productsList products: categories, options and media, without variants - post
/productsCreate a product with its variants - get
/products/{product}Get a product - patch
/products/{product}Change a product card: fields, categories, external ID - get
/products/by-external-id/{external_id}Get a product by its external ID - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID - put
/products/{product}/optionsReplace the product options and lay out its variants
- get
Released
Integration API v1
The first version of the contract: the store and its locations, catalog, stock, orders and their statuses, draft orders, payments and refunds, customers, uploads and bulk operations, events and webhooks. Every later change of the contract is listed here.