get https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/count
The data returned by the list interface may not necessarily be consistent with the order data displayed by the store admin. The store admin will filter out orders with a status of canceled and those without a shipping address and more filters.
Requires
read_orderaccess scope. More access scope
| Parameter Name | Type | Required | Parameter Value | Description |
|---|---|---|---|---|
| LineItems | Array of Object | Y | the List of Product | |
| line_item.variant_id | string | Y | ||
| product_id | string | Y | ||
| quantity | int | Y | Quantity of line item | |
| shipping_address | Object | Y | ||
| shipping_address.first_name | string | First name of consignee. | ||
| shipping_address.last_name | string | Y | Last name of consignee. | |
| shipping_address.phone | string | Phone number, for example: +86 150 1447 1143 | ||
| shipping_address.email | string | Y | ||
| shipping_address.country | string | Y | Country, for example: United States | |
| shipping_address.country_code | string | Y | Country code, for example: US | |
| shipping_address.province | string | Province, for example: New Mexico | ||
| shipping_address.province_code | Y | Province Code, for example: NM | ||
| shipping_address.area | string | |||
| shipping_address.city | string | Y | City, for example: SAN JOSE | |
| shipping_address.address | string | Y | Street address, for example: 1 Rue des Carrieres | |
| shipping_address.address1 | string | Apartment/floor/room number, for example: Suite 1234 | ||
| shipping_address.zip | string | ZIP code, for example: 87036 | ||
| shipping_address.company | string | Company, for example: ABC Limited | ||
| shipping_address.latitude | string | Latitude of the delivery address, for example: 22.54 | ||
| shipping_address.longitude | string | Longitude of the delivery address, for example: 114.06 | ||
| tags | array of string | Custom labels | ||
| tax_total | string | Y | Order tax, numeric string, for example: "9.99" | |
| currency_code | string | Y | e.g. "USD" | |
| discount | string | Discount amount or percent for the order, discount amount cannot be greater than total price of line items, e.g. "10.00", "10%" | ||
| note | string | Note of the order | ||
| payment_line | string | Payment method of the order, If you fill in "COD" and the merchant switch on cod, it is cod payment method, else if the merchant switch off "cod" ,you fill in anything it will automatically fill in the default payment method configured by the merchant in the store's admin. if you create a completed payment order, where 'payment_line' refers to the final method of payment. if you create an unpaid order, where 'payment_line' is just a suggested method of payment, not the final method that goes through the checkout process. | ||
| shipping_line | Object | Logistics solutions | ||
| shipping_line.name | string | Y | Name of shipping line, for example: "Free Shipping" | |
| shipping_line.shipping_price | string | Y | Shipping price, numeric string, for example: "10.00", "0" | |
| shipping_line.desc | string | Description of shipping line |