Rivier/ Reference/ shop

shop194

• Issue a credit note: it is numbered and reduces what the invoice is owedpost/credit-notes/{id}/issue
• Reject a credit note requestpost/credit-notes/{id}/reject
• Invoices by status, what they are for (an order, a stay) or a searchget/invoices
• Draft an invoice; idempotent on the key. It has no number until it is finalisedpost/invoices
• Credit notes, optionally for one invoiceget/invoices/credit-notes
• The number series for invoices and credit notesget/invoices/series
• Add a number series (gapless, optionally restarting each year)post/invoices/series
• The seller's details, default VAT and payment terms printed on invoicesget/invoices/settings
• Set the seller's details, default VAT, payment days and footerput/invoices/settings
• One invoice with its lines, tax groups, payments and what is dueget/invoices/{id}
• Change a draft invoicepatch/invoices/{id}
• Shop invoice clientput/invoices/{id}/client
• Shop credit note requestpost/invoices/{id}/credit-notes
• When an invoice was sent, opened by the client and reported paid by themget/invoices/{id}/doc-events
• What happened to an invoice, in orderget/invoices/{id}/events
• Number and freeze an invoicepost/invoices/{id}/finalise
• Shop invoice linkpost/invoices/{id}/link
• The private links of an invoice: expiry, views, whether revokedget/invoices/{id}/links
• Replace a link of an invoice with a new one; the old address stops workingpost/invoices/{id}/links/{linkId}/regenerate
• Switch one link of an invoice offpost/invoices/{id}/links/{linkId}/revoke
• Record a payment received against an invoice (a bank transfer, cash)post/invoices/{id}/payments
• The invoice as a PDFget/invoices/{id}/pdf
• The bank-transfer receipts the client uploaded at the invoice linkget/invoices/{id}/receipts
• One uploaded receipt file (editor and above)get/invoices/{id}/receipts/{receiptId}/download
• Email the invoice with its PDF to the customerpost/invoices/{id}/send
• Shop invoice send linkpost/invoices/{id}/send-link
• Shop invoice send link previewpost/invoices/{id}/send-link/preview
• Void an invoice nobody has paidpost/invoices/{id}/void
• The payment accounts of the project with their state in plain wordsget/payments/accounts
• Shop payment account connectpost/payments/accounts
• Approve live money on a verified accountpost/payments/accounts/{id}/approve-live
• Make an account the default for its modeput/payments/accounts/{id}/default
• Open the provider's identity check for an accountpost/payments/accounts/{id}/identity-link
• Open a receiving account that delivers to a walletpost/payments/accounts/{id}/receiving-accounts
• Ask the provider where onboarding standspost/payments/accounts/{id}/refresh
• The wallets, receiving accounts and payees kept for an accountget/payments/accounts/{id}/resources
• Read what the provider holds for an account nowpost/payments/accounts/{id}/resources/refresh
• Name a wallet or accountput/payments/accounts/{id}/resources/{rid}
• Take live approval awaypost/payments/accounts/{id}/revoke-live
• Open the provider's set-up pages for an accountpost/payments/accounts/{id}/setup-link
• Add a wallet to an accountpost/payments/accounts/{id}/wallets
• Checkouts by reference or stateget/payments/checkouts
• Shop checkout createpost/payments/checkouts
• One checkout and where it stands; refresh=1 asks the provider firstget/payments/checkouts/{id}
• Close an open checkout so it can no longer be paidpost/payments/checkouts/{id}/expire
• Differences found between the books and the providerget/payments/mismatches
• Close a difference with a note, or dismiss itpost/payments/mismatches/{id}/resolve
• Payments by reference (an order, a booking), status or pageget/payments/payments
• One payment with its status, what was received and refunded, and the feeget/payments/payments/{id}
• The money limitsget/payments/policy
• Set the money limitsput/payments/policy
• Compare the last days of payments with the provider and record differencespost/payments/reconcile
• Refunds by state or paymentget/payments/refunds
• Ask for a refundpost/payments/refunds
• Approve a refund; it is sent to the provider oncepost/payments/refunds/{id}/approve
• Reject a refund requestpost/payments/refunds/{id}/reject
• Proposals by status, client or a search, newest firstget/proposals
• Draft a proposal for a clientpost/proposals
• Shop proposal getget/proposals/{id}
• Change a proposalpatch/proposals/{id}
• The certificate of completion of an accepted proposal as a PDFget/proposals/{id}/certificate
• Turn an accepted proposal into a quote (the default) or into invoicespost/proposals/{id}/convert
• A new draft copied from a proposal, without its number; idempotent on the keypost/proposals/{id}/duplicate
• What happened to a proposal, in orderget/proposals/{id}/events
• A fresh private link to a sent proposal, to paste into a messagepost/proposals/{id}/link
• The private links of a proposalget/proposals/{id}/links
• Replace a link of a proposal with a new one; the old address stops workingpost/proposals/{id}/links/{linkId}/regenerate
• Switch one link of a proposal offpost/proposals/{id}/links/{linkId}/revoke
• The proposal as a PDFget/proposals/{id}/pdf
• Shop proposal previewpost/proposals/{id}/preview
• Shop proposal sendpost/proposals/{id}/send
• Void a proposal with the reason; it stays on record and its links stop workingpost/proposals/{id}/void
• Start a cartpost/public/shop/carts
• A cart priced as it standsget/public/shop/carts/{id}
• Set the cart's country and discount codespatch/public/shop/carts/{id}
• Add a variant to the cartpost/public/shop/carts/{id}/lines
• Change a line's quantity; zero removes itput/public/shop/carts/{id}/lines/{variantId}
• The storefront catalogueget/public/shop/catalog
• Place the order and, unless told not to, start the paymentpost/public/shop/checkout
• An order, through its own linkget/public/shop/orders/{id}
• Cancel an unpaid order through its linkpost/public/shop/orders/{id}/cancel
• The files a buyer is owed, as short-lived addresses, once the order is paidget/public/shop/orders/{id}/downloads
• A fresh payment address for an unpaid orderpost/public/shop/orders/{id}/pay
• Ask to return shipped lines, through the order's linkpost/public/shop/orders/{id}/returns
• Quotes by status, client or a search, newest firstget/quotes
• Draft a quote for a clientpost/quotes
• One quote with its lines, tax groups, status and the client's answerget/quotes/{id}
• Change a quotepatch/quotes/{id}
• The certificate of completion of an accepted quote as a PDFget/quotes/{id}/certificate
• Shop quote convertpost/quotes/{id}/convert
• A new draft copied from a quote, without its number; idempotent on the keypost/quotes/{id}/duplicate
• What happened to a quote, in orderget/quotes/{id}/events
• A fresh private link to a sent quote, to paste into a messagepost/quotes/{id}/link
• The private links of a quoteget/quotes/{id}/links
• Replace a link of a quote with a new one; the old address stops workingpost/quotes/{id}/links/{linkId}/regenerate
• Switch one link of a quote offpost/quotes/{id}/links/{linkId}/revoke
• The quote as a PDFget/quotes/{id}/pdf
• Shop quote previewpost/quotes/{id}/preview
• Shop quote sendpost/quotes/{id}/send
• Void a quote with the reason; it stays on record and its links stop workingpost/quotes/{id}/void
• How many of a variant can still be promised (a bundleget/shop/availability/{id}
• Make a variant a bundle of other variantsput/shop/bundles
• The parts of a bundle variantget/shop/bundles/{id}
• Stop selling a variant as a bundledelete/shop/bundles/{id}
• Start a cart in a currency and countrypost/shop/carts
• A cart priced as it stands: lines, discounts, shipping options, tax and totalget/shop/carts/{id}
• Set the cart's country and discount codespatch/shop/carts/{id}
• Add a variant to the cart. The stock is held for the buyerpost/shop/carts/{id}/lines
• Change a line's quantity; zero removes itput/shop/carts/{id}/lines/{variantId}
• What is for saleget/shop/catalog
• Retire a collection; its products staypost/shop/collection-archive/{id}
• Collections by name or slugget/shop/collection-search
• Collections and the products in eachget/shop/collections
• Add a collectionpost/shop/collections
• Add products to a collectionpost/shop/collections/{id}/items
• Take a product out of a manual collectiondelete/shop/collections/{id}/items/{productId}
• How complete a product is for a channel (storefront, google, openai, meta)get/shop/completeness
• Discounts with their rule, limits, status and useget/shop/discounts
• Add a discountpost/shop/discounts
• One discountget/shop/discounts/{id}
• Pause, resume or archive a discountput/shop/discounts/{id}/status
• The catalogue as a spreadsheetget/shop/export.csv
• The addresses places read this shop's product file from by themselvesget/shop/feed-links
• Shop feed link createpost/shop/feed-links
• Stop an address, so the place can no longer read the file from itdelete/shop/feed-links/{id}
• Shop feed getget/shop/feeds/{channel}
• Add and change products from a spreadsheet (same columns as the export)post/shop/import
• The places stock is keptget/shop/locations
• Add a stock location (warehouse, shop, supplier or virtual)post/shop/locations
• Retire a stock place that holds nothingpost/shop/locations/{id}/archive
• Margin of a variant's price against the cheapest supplier costget/shop/margin
• Orders by state or customerget/shop/orders
• Place an order from a cartpost/shop/orders
• Shop order syncpost/shop/orders/sync
• One order with its lines, money and the terms it was sold underget/shop/orders/{id}
• Correct the contact or delivery address of an order that has not shippedpatch/shop/orders/{id}
• Cancel an order nobody has paid for and give its stock backpost/shop/orders/{id}/cancel
• Cancel a paid order that has not shipped and ask for its refundpost/shop/orders/{id}/cancel-paid
• Close a delivered orderpost/shop/orders/{id}/complete
• Make the invoice for a paid order again (it is made on paymentpost/shop/orders/{id}/invoice
• A hosted checkout address for what is due on an orderpost/shop/orders/{id}/pay
• The payment history of an order: checkout, paid, refund asked, refundedget/shop/orders/{id}/payments
• Ask for a refund of part or all of what an order paidpost/shop/orders/{id}/refund
• Ask to send shipped lines backpost/shop/orders/{id}/returns
• Ship whole lines of a paid order with a carrier and trackingpost/shop/orders/{id}/ship
• What happened to an order, in orderget/shop/orders/{id}/timeline
• Every price a variant has been sold at, newest firstget/shop/price-history
• Live prices of a variant (all, with `all`)get/shop/prices
• Set a pricepost/shop/prices
• End a live pricepost/shop/prices/{id}/end
• Shop product listget/shop/products
• Put a product in draft (off the shop), active (on sale) or archivedput/shop/products/{id}/status
• Purchase orders by statusget/shop/purchase-orders
• Draft a purchase orderpost/shop/purchase-orders
• One purchase orderget/shop/purchase-orders/{id}
• Approve a draft purchase order (a person; an agent never approves its own)post/shop/purchase-orders/{id}/approve
• Cancel a purchase order that has not been receivedpost/shop/purchase-orders/{id}/cancel
• Goods arrived: mark received and put the quantities on the shelfpost/shop/purchase-orders/{id}/receive
• Send an approved purchase order; test mode only until live sending is openedpost/shop/purchase-orders/{id}/send
• Add a shipping rate to a zone (by weight, free over a total)post/shop/rates
• Change a shipping rate, or archive itpatch/shop/rates/{id}
• Cancelled orders that hold money nobody has asked to give backget/shop/refunds-due
• Shop reorder draftpost/shop/reorders/draft
• Returns by state or orderget/shop/returns
• Accept or reject a return requestpost/shop/returns/{id}/decision
• Record that the goods came backpost/shop/returns/{id}/receive
• Ask for the refund of an accepted returnpost/shop/returns/{id}/refund
• Shipments for an order or in a stateget/shop/shipments
• One shipmentget/shop/shipments/{id}
• Correct a shipment's carrier or tracking numberpatch/shop/shipments/{id}
• Mark a shipment deliveredpost/shop/shipments/{id}/deliver
• Stock of every variant of a product at every placeget/shop/stock
• Receive stock (positive) or correct it (negative), idempotent on the keypost/shop/stock
• Safety stock and backorder for a variant at a locationput/shop/stock-rules
• Which variants each supplier sells and at what costget/shop/supplied
• Say that a supplier sells a variant, at a unit costpost/shop/supplied
• Suppliersget/shop/suppliers
• Add a supplierpost/shop/suppliers
• One supplierget/shop/suppliers/{id}
• Stop buying from a supplier (an approver's decision)delete/shop/suppliers/{id}
• Tax rules with their dates, source and when they were last checkedget/shop/tax-rules
• Add a tax rule with its source and the date it was checkedpost/shop/tax-rules
• Change a tax rule's rate, dates or sourcepatch/shop/tax-rules/{id}
• The variants of a productget/shop/variants
• Shop variant createpost/shop/variants
• One variant with its SKU, options, weight, tax class, cost and price floorget/shop/variants/{id}
• Change a variant's SKU, options, weight, tax class, cost or price floorpatch/shop/variants/{id}
• Retire a variant. Refused while it is in a cart, an unshipped order or a bundlepost/shop/variants/{id}/archive
• Saved views of a list (search, filters, sort)get/shop/views
• Shop view savepost/shop/views
• Delete one of one's own saved viewsdelete/shop/views/{id}
• Shipping zones with their countries and ratesget/shop/zones
• Add a shipping zone (a set of countries)post/shop/zones
• Change a zone's name or countries, or archive itpatch/shop/zones/{id}