Store. 5 operations.
5 of them work. Each needs a bearer token with its scope. All operations.
Operations
GET/api/v1/store/backup-statusstore.backup-statusstore.read
POST/api/v1/store/logo/deletestore.clear-logostore.write
POST/api/v1/store/settingsstore.save-settingsstore.write
Schemas 23
BackupStatus
BackupStatus is the store's backup as engine health measures it: the Litestream replica of the database and the documents copied to the backup bucket, each with a state word. From contract version 6.
documentsrequired | DocumentsStatus |
listed_atrequired | string (date-time) |
replicarequired | ReplicaStatus |
CancelReason
CancelReason is a reason a cancel is picked from: the text the buyer is shown, and, for one of the engine's five, its code; "" for a reason the owner wrote.
code | string |
textrequired | string |
DispatchSettings
DispatchSettings are when the store sends an order out: its lead time in dispatch days, from 0 to 30; the weekdays it dispatches on, at least one, each of mon, tue, wed, thu, fri, sat and sun, which an answer gives Monday first; and the time of day, HH:MM in the store's zone, from which an order counts from the next day, "" for none.
cutoffrequired | string |
daysrequired | array of string |
lead_daysrequired | integer |
DocumentsStatus
DocumentsStatus is the documents copied to the backup bucket. Pending is how many are recorded in no replica, of any age, and OldestSeconds the age of the oldest, 0 for none; the state is behind once one has waited longer than GraceSeconds.
grace_secondsrequired | integer |
namerequired | string |
oldest_secondsrequired | integer |
pendingrequired | integer |
staterequired | string |
Money
Money is an amount: in minor units of its ISO 4217 currency, and as the store displays it.
currencyrequired | string |
displayrequired | string |
minorrequired | integer |
PostalAddress
PostalAddress is an address in its fields, as the store's details take and give it. From contract version 6.
cityrequired | string |
countryrequired | string |
country_name | string |
line1required | string |
line2required | string |
postal_coderequired | string |
provincerequired | string |
suburbrequired | string |
text | string |
ReplicaStatus
ReplicaStatus is the database's replica. Name is the location as store.yaml writes it, no key. Heartbeat is the newest heartbeat engine health wrote, null before the first; LagSeconds is how long it has gone uncopied, 0 while the replica holds it, over LimitSeconds (health. replica_lag_max_seconds) the state is behind. SnapshotAt is the newest snapshot's time and RestorableFrom the oldest one's, how far back a restore reaches; each null when the replica lists no snapshot, which means not known, not none.
heartbeatrequired | string (date-time) |
lag_secondsrequired | integer |
limit_secondsrequired | integer |
namerequired | string |
restorable_fromrequired | string (date-time) |
snapshot_atrequired | string (date-time) |
staterequired | string |
StoreAddressLookup
StoreAddressLookup is the address lookup the checkout offers as the buyer types the street: whether it is on, its provider, the provider's calls a day at most, and one client's share of them, a percentage. The key is no setting: it stays a secret declared in store.yaml and set in the environment, which /admin and the API never take; KeyPlaced says whether it is there, never the key or its name. A save sends StoreAddressLookupRequest. From version 6.
client_sharerequired | integer |
daily_limitrequired | integer |
enabledrequired | boolean |
key_placedrequired | boolean |
limit_hitrequired | boolean |
providerrequired | string |
used_todayrequired | integer |
StoreAddressLookupRequest
StoreAddressLookupRequest are the address lookup's settings a save sends, each kept as saved when left out: Enabled, DailyLimit or ClientShare null or absent, and a Provider of "". A number given is checked against StoreAddressLookup's bounds, 0 too: 0 is refused, never read as "keep" (L1, Verification's walk). From version 6.
client_share | integer |
daily_limit | integer |
enabled | boolean |
provider | string |
StoreBank
StoreBank are the store's bank details: the account an EFT term is paid into, public on the store's documents. The holder, bank, account number, branch code and account type are given together or not at all. AccountNumber is 5 to 16 digits and BranchCode 4 to 8, spaces and hyphens taken out when saved; AccountType is current, savings, transmission or other; SWIFT, optional, is 8 or 11 letters and digits; ReferenceRule is what the payer writes as the payment reference, order_number (the default) or document_number; Notes are at most 3 lines of at most 100 characters. Additive.
account_holderrequired | string |
account_numberrequired | string |
account_typerequired | string |
bank_namerequired | string |
branch_coderequired | string |
notesrequired | array of string |
reference_rule | string |
swift | string |
StoreCashOnDelivery
StoreCashOnDelivery are the cash on delivery settings of the store: the most an order may total and be offered the method (a zero amount is no limit), the days a cash on delivery order may wait before it is on the attention list (1 to 90, default 14), and when the tax invoice of such an order is made: collected, with the cash (the default), or dispatched. The method is on or off as a payment gateway is. A save sends StoreCashOnDeliveryRequest. From version 6. The fee of the method (additive): a fixed amount, a percent of the order's total before the fee in basis points, the most the whole fee may be (a zero amount is none of each), the tax class of the fee line ("" follows the shipping line's) and whether an order's refund keeps the fee.
StoreCashOnDeliveryRequest
StoreCashOnDeliveryRequest are the cash on delivery settings a save sends, each kept as saved when left out. MaxOrder is the most an order may total and be offered cash on delivery, written as a price with two decimals such as 500.00; 0.00 is no limit. HoldDays is 1 to 90. InvoiceAt is collected or dispatched. From version 6. The fee (additive): FeeFixed and FeeCap are prices with two decimals, FeePercent is basis points of the order's total before the fee (0 to 10 000), all 0 for none; FeeTaxClass names the tax class of the fee line, "" for the shipping line's; KeepFeeOnRefund keeps the fee when the order is refunded. Each is kept as saved when left out (null), and one given is checked, 0 too.
fee_cap | string |
fee_fixed | string |
fee_percent | integer |
fee_tax_class | string |
hold_days | integer |
invoice_at | string |
keep_fee_on_refund | boolean |
max_order | string |
StoreCollectionPlace
StoreCollectionPlace is one of the store's own places where a buyer collects the order: its key, its name, its address, its opening hours in the store's own words ("" for none) and what collecting costs, as the store writes a price, such as 0.00 for free.
addressrequired | PostalAddress |
hoursrequired | string |
keyrequired | string |
namerequired | string |
pricerequired | string |
StoreEFT
StoreEFT are the days of the checkout's bank transfer: RemindAfterDays, the payment reminder's day after the order waits, 0 for none; CancelAfterDays, the system's cancel of an order still unpaid, 0 for the store's general rule.
cancel_after_daysrequired | integer |
remind_after_daysrequired | integer |
StoreEFTRequest
StoreEFTRequest are the EFT days a save sends: a field left out keeps the store's.
cancel_after_days | integer |
remind_after_days | integer |
StoreEnquiries
StoreEnquiries are the store's enquiry settings (ASI-6.5), from store.yaml, read only in this version.
copy_customerrequired | boolean |
mailrequired | boolean |
mail_torequired | string |
StoreManualOrders
StoreManualOrders are the payment terms and the settings of the orders the owner enters and the quotes they come from. Terms are 1 to 20 (none given: the one pay_now term, "now"); CreditCheck is warn (an order over a customer's credit limit is accepted with a warning) or refuse, warn by default; QuoteValidDays is 1 to 365, 14 by default; QuoteReserve is none (the default) or until_valid; QuoteWarnDays is 0 to 60, 3 by default, the days before a quote ends that the owner is warned; QuoteRemindDays is 0 to 60, the days after a quote is sent that its client is reminded, 0 for never; QuoteFooter is the text at the foot of a quote. Additive.
credit_checkrequired | string |
quote_footerrequired | string |
quote_remind_daysrequired | integer |
quote_reserverequired | string |
quote_valid_daysrequired | integer |
quote_warn_daysrequired | integer |
termsrequired | array of StorePaymentTerm |
StorePaymentTerm
StorePaymentTerm is one of the store's payment terms: an id (lower-case letters, digits, - and _), the label the client sees, and a Kind: pay_now (the client pays by the order's link; PayWindowDays is how many days it waits, 7 by default), eft (the client pays by bank transfer against a pro forma invoice; EFTHoldDays is how many days it waits before the attention list, 14 by default) or account (the client is invoiced and pays DueDays after the invoice, 0 on receipt; InvoiceAt is accepted or dispatched, the default). The parts of another kind are refused. Additive.
due_days | integer |
eft_hold_days | integer |
idrequired | string |
invoice_at | string |
kindrequired | string |
labelrequired | string |
pay_window_days | integer |
StorePolicies
StorePolicies are the URLs of the store's policies, each an http or https address, "" for none.
adrrequired | string |
privacyrequired | string |
returnsrequired | string |
securityrequired | string |
termsrequired | string |
StoreSettings
StoreSettings are the store's details as they rule: saved, or store.yaml's as the first save copies them, with the revision a save must send; the store's logo; and, read only, what stays store.yaml's. From contract version 6.
addressrequired | PostalAddress |
address_lookuprequired | StoreAddressLookup |
bankrequired | StoreBank |
base_urlrequired | string |
cancel_reasonsrequired | array of CancelReason |
cancel_reasons_defaultrequired | boolean |
cash_on_deliveryrequired | StoreCashOnDelivery |
collectionrequired | array of StoreCollectionPlace |
currencyrequired | string |
dispatchrequired | DispatchSettings |
eftrequired | StoreEFT |
emailrequired | string |
enquiriesrequired | StoreEnquiries |
languagerequired | string |
logorequired | string |
mail_test_addressesrequired | array of string |
manual_ordersrequired | StoreManualOrders |
namerequired | string |
next_dispatchrequired | string |
phonerequired | string |
policiesrequired | StorePolicies |
requiredrequired | array of string |
revisionrequired | integer |
savedrequired | boolean |
saved_atrequired | string (date-time) |
saved_byrequired | string |
supplierrequired | StoreSupplier |
timezonerequired | string |
vatrequired | StoreVAT |
StoreSettingsRequest
StoreSettingsRequest is the store's details whole, which replace the details at Revision: a detail left out is "" or none, never kept. From contract version 6.
addressrequired | PostalAddress |
address_lookuprequired | StoreAddressLookupRequest |
bankrequired | StoreBank |
cancel_reasonsrequired | array of CancelReason |
cash_on_deliveryrequired | StoreCashOnDeliveryRequest |
collectionrequired | array of StoreCollectionPlace |
dispatchrequired | DispatchSettings |
eftrequired | StoreEFTRequest |
emailrequired | string |
mail_test_addressesrequired | array of string |
manual_ordersrequired | StoreManualOrders |
namerequired | string |
phonerequired | string |
policiesrequired | StorePolicies |
revisionrequired | integer |
supplierrequired | StoreSupplier |
vatrequired | StoreVAT |
StoreSupplier
StoreSupplier is who sells: its legal name, status, registration number and office bearers, its physical address, which every tax invoice carries, and where it accepts legal service of documents.
legal_addressrequired | PostalAddress |
legal_namerequired | string |
legal_statusrequired | string |
officersrequired | array of string |
registration_numberrequired | string |
service_addressrequired | PostalAddress |
StoreVAT
StoreVAT is the store's VAT registration: whether it is registered, its rate in basis points (1500 is 15 %), its VAT number, "" for a store not registered, and its VAT period in months, 0 for the default, 2.
numberrequired | string |
period_monthsrequired | integer |
raterequired | integer |
registeredrequired | boolean |
Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.