Skapa eller uppdatera order
PUT/api/v1/stores/{store_id}/orders/{order_id}
Skapar ordern med butikens id, eller uppdaterar den – skicka ordern igen när den ändras (betald, återbetald, avbruten).
Ordern skickas hel: kunden, totalbeloppet och alla rader. Kunden skapas eller uppdateras med den, och raderna ersätter de tidigare. campaign_id, financial_status, currency, processed_at och delbeloppen behåller sina värden om du utelämnar dem.
Bara betalda ordrar (paid) räknas som köp i distributionslistornas villkor och som intäkt för kampanjen i campaign_id. Delvis återbetald: skicka ordern igen med det nya totalbeloppet.
Svarar 201 när ordern skapades och 200 när den uppdaterades.
Behörighet
ecommerce:writeÄndra e-handel – personen bakom nyckeln måste vara redaktör eller högre.
Sökvägsparametrar
store_idstringkrävs- Butikens id, som ni väljer.
order_idstringkrävs- Orderns id i er butik.
Kropp
JSON, Content-Type: application/json. Okända fält ger 422.
customerobjectkrävs- Kunden. Skapas eller uppdateras med ordern (samma regler som PUT /customers/{customer_id}).
customer.idstringkrävs- Kundens id i er butik.
customer.emailstringkrävs- Kundens e-postadress.högst 254 tecken
customer.first_namestring | null- Förnamn.högst 100 tecken
customer.last_namestring | null- Efternamn.högst 100 tecken
customer.companystring | null- Företag.högst 200 tecken
campaign_idstring | null- Kampanjen kunden kom från: värdet av qn_cid på länken hen klickade på. Räknas bara för arbetsytans egna kampanjer; ett okänt id sparas inte (men ordern sparas).
financial_statusstring- paid: betald – räknas som köp · pending: väntar på betalning · refunded: återbetald · cancelled: avbruten. Standard när ordern skapas: paid.
pendingpaidrefundedcancelled currencystring- Standard: butikens valuta.
order_totalnumberkrävs- Orderns totalbelopp, inklusive moms och frakt.minst 0 · högst 999999999999.99
tax_totalnumber | null- Varav moms.minst 0 · högst 999999999999.99
shipping_totalnumber | null- Varav frakt.minst 0 · högst 999999999999.99
discount_totalnumber | null- Rabatt.minst 0 · högst 999999999999.99
processed_atstring- När ordern lades i butiken (ISO 8601). Standard när ordern skapas: nu. Skicka den vid import av gamla ordrar.
linesarray<object>krävs- Orderns rader (högst 500). Ersätter alla rader. Produkterna behöver inte ha skickats in.minst 1 · högst 500 st
lines[].idstringkrävs- Radens id i er butik.
lines[].product_idstringkrävs- Produktens id i er butik.
lines[].variant_idstring | null- Variantens id i er butik.
lines[].titlestring | null- Vad som köptes, som det stod på ordern.högst 255 tecken
lines[].quantityintegerkrävs- Antal.minst 1 · högst 1000000
lines[].pricenumberkrävs- Pris per styck.minst 0 · högst 999999999999.99
lines[].discountnumber | null- Rabatt på raden.minst 0 · högst 999999999999.99
Göra om anropet
PUT skapar eller uppdaterar på butikens egna id: samma anrop två gånger ger samma resultat, så det kan alltid göras om. Batch och idempotens
Svar
200 Ordern (201 om den skapades).
idstringkrävscustomerobject | nullkrävs- null när kunden har raderats: ordern räknas fortfarande till kampanjens intäkt.
customer.idstringkrävscustomer.emailstringkrävscampaign_idstring | nullkrävsfinancial_statusstringkrävspendingpaidrefundedcancelledcurrencystringkrävsorder_totalnumberkrävstax_totalnumber | nullkrävsshipping_totalnumber | nullkrävsdiscount_totalnumber | nullkrävsprocessed_atstring (tid, ISO 8601)krävs- När ordern lades.
linesarray<object>krävslines[].idstringkrävslines[].product_idstringkrävslines[].variant_idstring | nullkrävslines[].titlestring | nullkrävslines[].quantityintegerkrävslines[].pricenumberkrävslines[].discountnumber | nullkrävscreated_atstring (tid, ISO 8601)krävs- När ordern skickades in första gången.
updated_atstring (tid, ISO 8601)krävs- När ordern senast ändrades.
Fel
- 400
- bad_request
- 404
- not_found
- 429
- rate_limited