Hoppa till innehållet

Referens / Ordrar

Lista ordrar

GET/api/v1/stores/{store_id}/orders

Butikens ordrar med rader, en sida i taget.

Intäkt per kampanj →

Behörighet

  • ecommerce:read Läsa e-handel – personen bakom nyckeln måste vara alla medlemmar.

Sökvägsparametrar

store_idstringkrävs
Butikens id, som ni väljer.

Query-parametrar

limitinteger
Hur många som högst ska komma i svaret (1–250, standard 100).minst 1 · högst 250 · standard 100
cursorstring
next_cursor från förra svaret, för nästa sida. Utelämna för första sidan.
customer_idstring
Bara kundens ordrar (butikens kund-id).
campaign_idstring
Bara ordrar från kampanjen.
financial_statusstring
Bara ordrar med den statusen.pendingpaidrefundedcancelled
updated_sincestring
Bara det som ändrats sedan dess (ISO 8601).

Svar

200 En sida ordrar.

dataarray<object>krävs
data[].idstringkrävs
data[].customerobject | nullkrävs
null när kunden har raderats: ordern räknas fortfarande till kampanjens intäkt.
data[].customer.idstringkrävs
data[].customer.emailstringkrävs
data[].campaign_idstring | nullkrävs
data[].financial_statusstringkrävs
pendingpaidrefundedcancelled
data[].currencystringkrävs
data[].order_totalnumberkrävs
data[].tax_totalnumber | nullkrävs
data[].shipping_totalnumber | nullkrävs
data[].discount_totalnumber | nullkrävs
data[].processed_atstring (tid, ISO 8601)krävs
När ordern lades.
data[].linesarray<object>krävs
data[].lines[].idstringkrävs
data[].lines[].product_idstringkrävs
data[].lines[].variant_idstring | nullkrävs
data[].lines[].titlestring | nullkrävs
data[].lines[].quantityintegerkrävs
data[].lines[].pricenumberkrävs
data[].lines[].discountnumber | nullkrävs
data[].created_atstring (tid, ISO 8601)krävs
När ordern skickades in första gången.
data[].updated_atstring (tid, ISO 8601)krävs
När ordern senast ändrades.
has_morebooleankrävs
Det finns fler: hämta nästa sida med cursor=next_cursor.
next_cursorstring | nullkrävs
Skicka som cursor för nästa sida. null på sista sidan.

Fel