Tillwire Read the guide
API reference

Customers. 4 operations.

4 of them work. Each needs a bearer token with its scope. All operations.

Operations

POST/api/v1/customerscustomers.createcustomers.write

Parameters

Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/customers

GET/api/v1/customers/{email}customers.getcustomers.read

Parameters

emailpathstring
emailpathstring
pagequeryintegerSee common parameters

Errors: 401, 403, 404, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/customers/{email}

GET/api/v1/customerscustomers.listcustomers.read

Parameters

pagequeryintegerSee common parameters

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/customers

Schemas 34

Address

Address is a postal address in its fields and on one line: the domain's address, which the store's own address will take when the operations give store details.

cityrequiredstring
countryrequiredstring
country_namerequiredstring
linesrequiredarray of string
postal_coderequiredstring
provincerequiredstring
suburbrequiredstring
textrequiredstring
Buyer

Buyer is who placed an order, as the checkout took it.

addressrequiredstring
billing_addressAddress
business_namestring
delivery_addressrequiredAddress
emailrequiredstring
namerequiredstring
phonerequiredstring
regionstring
vat_numberstring
CashCollected

CashCollected is the cash of an order paid on delivery as it was collected.

actorrequiredstring
amountrequiredMoney
atrequiredstring (date-time)
howstring
referencestring
CollectPlace

CollectPlace is a place of the store the buyer collects an order at, as the order keeps it: the place's key and name, its address in one line (the street, the suburb, the city and the postal code, as far as each is known) and its opening hours as the owner wrote them (CR-4).

addressrequiredstring
hoursrequiredstring
keyrequiredstring
namerequiredstring
Customer

Customer is a contact as the owner sees it (additive from version 6): its address, as the store keeps it, whether it holds an account, the source that first named it (checkout, account, signup, or an import) and when, and its paid orders: how many, what they spent, VAT and shipping in, less what was refunded, and when the first and the last were placed.

accountrequiredboolean
created_atrequiredstring (date-time)
emailrequiredstring
first_orderstring (date-time)
last_orderstring (date-time)
namestring
ordersrequiredinteger
sourcerequiredstring
spentrequiredMoney
CustomerConsent

CustomerConsent is a customer's consent to one topic as it stands: its kind (given, confirmed, imported, withdrawn) and when.

atrequiredstring (date-time)
kindrequiredstring
topicrequiredstring
CustomerCreateRequest

CustomerCreateRequest adds a customer by the address a mail can go to. The customer holds no consent: this gives none.

emailrequiredstring
CustomerCreated

CustomerCreated is the answer of customers.create: the address, as the store keeps it, and whether this call made the contact (false: the store held it already). Customer is the customer's view, given only to a token that reads customers (customers.read): a token that may only write learns nothing of a customer the store already knew.

createdrequiredboolean
customerCustomer
emailrequiredstring
CustomerDetail

CustomerDetail is one customer, a page of its orders, paid or not, newest first, how many it has in all, and its consents, by topic.

consentsrequiredarray of CustomerConsent
customerrequiredCustomer
ordersrequiredarray of Order
orders_ofrequiredinteger
CustomerList

CustomerList is a page of the customers, newest first, how many there are in all, and whether more follow.

customersrequiredarray of Customer
morerequiredboolean
ofrequiredinteger
DeliveryFacts

DeliveryFacts are an order's delivery (from version 6): its kind, one of the Delivery kinds; its method in the engine's words (the zone's name, the flat rate, the courier's service and how it reaches the buyer, or no delivery); the shipping line's price; and how many units of products the order holds.

itemsrequiredinteger
kindrequiredstring
pricerequiredMoney
wordsrequiredstring
DownloadRecord

DownloadRecord is one download of a grant: when, and the SHA-256 of the file it served. From version 6.

atrequiredstring (date-time)
digestrequiredstring
Event

Event is one change of an order's status.

actorrequiredstring
atrequiredstring (date-time)
carrierstring
codestring
correctsinteger
notestring
reasonstring
statusrequiredstring
trackingstring
Line

Line is one line of an order, as copied at confirm.

choicesrequiredarray of LineChoice
comboLineCombo
discountrequiredMoney
downloadLineDownload
kindrequiredstring
made_to_orderrequiredboolean
no_deliveryboolean
option_valuesrequiredarray of string
pickup_pointPickupPoint
price_logLinePriceLog
production_daysrequiredinteger
quantityrequiredinteger
quoteQuote
quoted_bystring
skurequiredstring
titlerequiredstring
totalrequiredMoney
unit_pricerequiredMoney
LineChoice

LineChoice is a buyer's answer on a cart line or an order line: the label the field had at the confirm, and the value. An order never changes it, and a privacy erasure of the buyer replaces a text value with the catalogue's word "erased".

keyrequiredstring
labelrequiredstring
valuerequiredstring
LineCombo

LineCombo is the combo a part line came from: its SKU and its title as they were at confirm, how many combos the order holds, and Index, which combo line of the cart it was, from 0 (two lines of one combo at two cadences stay apart). First is true on the first part line of the combo. Total, Discount and VAT are the sums of the combo's part lines: the discount, the total after it and the VAT in it.

discountrequiredMoney
firstrequiredboolean
indexrequiredinteger
optionsstring
quantityrequiredinteger
skurequiredstring
titlerequiredstring
totalrequiredMoney
vatMoney
LineDownload

LineDownload is a digital line's download grant as the owner sees it: the most downloads it allows, the downloads used, its expiry, when it was revoked (null while it stands), and its downloads, newest first, at most 50, each with the digest of the file it served; no IP address and no user agent are kept. From version 6.

expires_atrequiredstring (date-time)
maxrequiredinteger
recordsrequiredarray of DownloadRecord
regranted_atrequiredstring (date-time)
revoked_atrequiredstring (date-time)
usedrequiredinteger
LinePriceLog

LinePriceLog is the price log of an order line the owner priced: Reason, By (who set the price, such as user:owner), At, and Catalogue, the catalogue's price of one unit it stands against (zero for a custom line, which has none).

atrequiredstring (date-time)
byrequiredstring
cataloguerequiredMoney
reasonrequiredstring
Money

Money is an amount: in minor units of its ISO 4217 currency, and as the store displays it.

currencyrequiredstring
displayrequiredstring
minorrequiredinteger
Order

Order is an order as the owner sees it.

actionsrequiredarray of string
amount_duerequiredMoney
buyerrequiredBuyer
cashrequiredOrderCash
collectCollectPlace
deliveryrequiredDeliveryFacts
dispatch_byrequiredstring
eventsrequiredarray of Event
fee_keptrequiredboolean
flagsrequiredarray of string
gatewayrequiredstring
gift_card_paidrequiredMoney
linesrequiredarray of Line
linkedOrderLink
methodrequiredstring
notesrequiredarray of OrderNote
numberrequiredinteger
paymentrequiredPaymentFacts
placed_atrequiredstring (date-time)
po_numberstring
posOrderPOS
refundablerequiredMoney
refundsrequiredarray of Refund
shipmentsrequiredarray of Shipment
sourcerequiredstring
statusrequiredstring
tendersrequiredarray of Tender
termsOrderTerms
timelinerequiredarray of TimelineEntry
totalrequiredMoney
OrderCash

OrderCash is the cash of an order paid on delivery: what is to be collected, the order's frozen total, and, once it was, the cash collected (null before): when, how much and who said so (the owner, an integration, or the courier). The order's status is not changed by it. An order under account terms shows it too, as its payment on account: ToCollect is the invoice's total and Collected the payment once recorded, with how it was made and its reference (additive).

collectedrequiredCashCollected
to_collectrequiredMoney
OrderNote

OrderNote is one internal note of an order (from version 6): its text, who wrote it in words (owner, or an integration's name), and when. No buyer's page or mail shows it.

atrequiredstring (date-time)
byrequiredstring
textrequiredstring
OrderPOS

OrderPOS is the sale at the till an order is: the key and the name of the stock location it was sold at, the device and its sale number, when it was sold by the device's clock (the order's placed_at is when the store received it).

devicerequiredstring
locationrequiredstring
location_namerequiredstring
made_before_stoprequiredboolean
price_differsrequiredboolean
sale_numberrequiredstring
sellerOrderSeller
sold_atrequiredstring (date-time)
OrderSeller

OrderSeller is the team member who sold a sale at the till: the account's id, its name ("" for none) and its email.

emailrequiredstring
idrequiredinteger
namerequiredstring
OrderTerms

OrderTerms are the payment terms an order was entered under: the term's id in the store's settings, its kind (pay_now, eft or account), the days after the invoice that it falls due (0: on receipt) and the moment of the tax invoice (accepted or dispatched; "" for a kind that has none).

due_daysrequiredinteger
idrequiredstring
invoice_atstring
kindrequiredstring
PaymentFacts

PaymentFacts are an order's payment (from version 6): its method's id and its gateway's name ("" for none); what it paid, its frozen total once paid, else nothing; when it was paid, null while it never was; the gateway's reference of its last captured payment, "" for none; and what was refunded of it, declined refunds aside. State is where its payment stands, one of the Payment states, "" for none of them (such as an order cancelled before it was paid), by the rule orders.search's payment filter narrows by.

amountrequiredMoney
gatewayrequiredstring
howrequiredstring
methodrequiredstring
paid_atrequiredstring (date-time)
referencerequiredstring
refundedrequiredMoney
staterequiredstring
PickupPoint

PickupPoint is a pickup point or a locker an order is delivered to, as the courier connector listed it at the confirm: the connector's id of it, its kind (pickup_point or locker), who runs it, its name, the courier's own words about it, its address, where it is (lat and lng, null when not known), its distance in metres from the buyer's address (null when not given), its hours, one line per day as given, and provider, the connector that listed it, which books it. From version 6.

addressrequiredPostalAddress
carrierrequiredstring
descriptionrequiredstring
distance_mrequiredinteger
hoursrequiredarray of string
idrequiredstring
kindrequiredstring
latrequirednumber
lngrequirednumber
namerequiredstring
providerrequiredstring
PostalAddress

PostalAddress is an address in its fields, as the store's details take and give it. From contract version 6.

cityrequiredstring
countryrequiredstring
country_namestring
line1requiredstring
line2requiredstring
postal_coderequiredstring
provincerequiredstring
suburbrequiredstring
textstring
Quote

Quote is what a courier said of an order's shipping line, each part "" when it did not say: the service's name, the carrier, the courier's code of the service, how the parcel reaches the buyer (door, pickup_point or in_store), and the estimated delivery dates (YYYY-MM-DD).

carrierrequiredstring
delivery_fromrequiredstring
delivery_torequiredstring
display_namestring
kindrequiredstring
servicerequiredstring
service_coderequiredstring
Refund

Refund is one refund of an order.

actorrequiredstring
amountrequiredMoney
atrequiredstring (date-time)
cancelrequiredboolean
reasonrequiredstring
staterequiredstring
Shipment

Shipment is one shipment of an order as last corrected (from version 6): the id a correction names, the carrier and tracking number, when it was shipped, and whether the owner corrected it since.

atrequiredstring (date-time)
carrierrequiredstring
correctedrequiredboolean
idrequiredinteger
trackingrequiredstring
Tender

Tender is one payment of an order: a gift card, or the method of the rest (ASI-5 ). The code of a card is never in it.

amountrequiredMoney
atstring (date-time)
kindrequiredstring
labelrequiredstring
last4string
leftMoney
TimelineEntry

TimelineEntry is one thing that happened to an order (from version 6): when; its kind, one of the Timeline kinds; who did it, in words (owner, guest, payment, system, courier, or an integration's name, never its raw id); the engine's words for it; and, by kind, its status (a status entry's status, a refund's state, a payment's type such as captured or failed), its amount (a cash collected's, a payment's, a refund's), its reference (a payment's gateway reference, a shipment's tracking number), its SKU (a download grant's) and its template (a mail's type). Entries are oldest first; entries of the same time in the order of the kinds, then as they were recorded.

amountMoney
atrequiredstring (date-time)
byrequiredstring
kindrequiredstring
referencestring
skustring
statusstring
templatestring
wordsrequiredstring

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.