Shoplazza Order API
The Order API from Shoplazza — 11 operation(s) for order.
OpenAPI Specification
openapi: 3.1.0
info:
title: SPZ Admin Access Order API
version: '2022.01'
servers:
- url: https://{subdomain}.myshoplaza.com
variables:
subdomain:
default: developer
security:
- sec0: []
tags:
- name: Order
description: ''
paths:
/openapi/2022-01/orders:
get:
summary: Order List
deprecated: false
description: ''
operationId: order-list
tags:
- Order
parameters:
- name: ids
in: query
description: Order's IDs, please use comma as separator, for example `183211-00000005,183211-00000006`
required: false
schema:
type: string
- name: limit
in: query
description: 'Limit per page, default: `10`, maximum: `250`'
required: false
schema:
type: integer
format: int32
- name: page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
- name: created_at_min
in: query
description: 'Filter orders created at or after date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: created_at_max
in: query
description: 'Filter orders created at or before date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: updated_at_min
in: query
description: 'Filter orders last updated at or after date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: updated_at_max
in: query
description: 'Filter orders last updated at or before date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: placed_at_min
in: query
description: 'Filter orders placed at or after date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: placed_at_max
in: query
description: 'Filter orders placed at or before date, for example: `2016-01-18T23:41:00Z`'
required: false
schema:
type: string
- name: status
in: query
description: 'Filter orders by status: `opened`, `placed`, `finished`, `cancelled`'
required: false
schema:
type: string
- name: financial_status
in: query
description: 'Filter orders by financial status: `waiting`, `paying`, `paid`, `cancelled`, `failed`, `refunding`, `refund_failed`, `refunded`, `partially_refunded`'
required: false
schema:
type: string
- name: fulfillment_status
in: query
description: 'Filter orders by fulfillment status: `initialled`, `waiting`, `partially_shipped`, `shipped`, `partially_finished`, `finished`, `cancelled`, `returning`, `returned`'
required: false
schema:
type: string
- name: recovery_status
in: query
description: 'Filter orders by recovery status: `waiting`, `sending`, `recalling`, `failed`, `success`'
required: false
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/Order'
examples:
'1':
summary: Result
value:
orders:
- id: 11218-00000001
note: abc
number: '00000001'
financial_status: paid
status: placed
cancel_reason: null
payment_method: online
fulfillment_status: partially_shipped
discount_code: ''
discount_applications: '[]'
customer_note: note
landing_site: http://www.example.com?source=abc
buyer_accepts_marketing: false
currency: USD
total_price: '16.99'
total_discount: '100.00'
total_tax: '10.00'
total_shipping: '1.00'
sub_total: '15.00'
code_discount_total: '1.00'
line_item_discount_total: '1.00'
tags: a, b
created_at: '2014-04-25T16:15:47Z'
updated_at: '2014-04-25T16:15:47Z'
canceled_at: null
customer_deleted_at: '2014-04-25T16:15:47Z'
deleted_at: '2014-04-25T16:15:47Z'
placed_at: '2014-04-25T16:15:47Z'
total_refund_price: '0.00'
total_refund_tax: '0.00'
total_refund_discount: '0.00'
refund_status: none
total_tip_received: '0.00'
browser_ip: 192.168.0.1
source: http://www.example.com?source=abc
last_landing_url: http://www.example.com?source=abc
email_status: send
recovery_status: success
total_paid: '16.99'
source_name:
data: Direct
created_at: '2014-04-25T16:15:47Z'
last_referrer_show:
data: Others
created_at: '2014-04-25T16:15:47Z'
shipping_line:
name: free
customer:
id: ef0318fe-e0ed-4551-a5bc-8b8e36c4f90f
email: bob.norman@hostmail.com
first_name: Bob
last_name: Norman
phone: ''
created_at: '2018-11-02T12:30:10Z'
updated_at: '2018-11-02T12:30:10Z'
orders_count: 1
total_spent: '41.94'
shipping_address:
first_name: Bob
last_name: Norman
address1: Chestnut Street 92
address2: ''
phone: 555-625-1199
city: Louisville
zip: '40202'
province: Kentucky
country: United States
company: ''
latitude: '45.41634'
longitude: '-75.6868'
name: Bob Norman
country_code: US
province_code: US-KY
phone_area_code: '80'
email: bob.norman@hostmail.com
area: sz
extra_info:
cpf: '123'
tax_text: CPF/CNPJ
billing_address:
first_name: Bob
last_name: Norman
address1: Chestnut Street 92
address2: ''
city: Louisville
zip: '40202'
province: Kentucky
country: United States
company: ''
latitude: '45.41634'
longitude: '-75.6868'
name: Bob Norman
country_code: US
province_code: KY
email: test@gmail.com
area: sz
phone: 555-625-1199
payment_line:
payment_channel: paypal
payment_method: online
transaction_no: 52Y26167A2351800A
merchant_id: 26167A23518
merchant_email: abc@def.com
line_items:
- id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
product_id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
variant_id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
variant_title: XXX
product_title: abc
product_handle: abc
quantity: 10
note: red
fulfillment_status: waiting
sku: xxx
weight_unit: g
vendor: XXX
product_url: http://www.a.com/abc
compare_at_price: '12.34'
image: http://www.a.com/xxx.jpg
price: '12.34'
total: '123.40'
weight: '1.23'
properties:
- name: color
value: red
custom_properties:
prop: value
refund_quantity: 0
refund_total: '0.00'
fulfillments:
- id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
order_id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
status: waiting
tracking_company: company
tracking_number: 1Z2345
tracking_company_code: '3306'
created_at: '2018-11-02T12:30:10Z'
updated_at: '2018-11-02T12:30:10Z'
line_items:
- id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
product_id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
variant_id: db4469f3-5e56-4c69-a2b6-03e81d24d5b5
variant_title: XXX
product_title: abc
product_handle: abc
quantity: 10
note: red
fulfillment_status: waiting
sku: xxx
weight_unit: g
vendor: XXX
product_url: http://www.a.com/abc
compare_at_price: '12.34'
image: http://www.a.com/xxx.jpg
price: '12.34'
total: '123.40'
weight: '1.23'
properties:
- name: color
value: red
custom_properties:
prop: value
refund_quantity: 0
refund_total: '0.00'
taxable: false
requires_shipping: true
shipping_quantity: 1
gift_card_total: '0.00'
shipping_tax_total: '12.00'
product_tax_included: true
config:
page_type: three_step
requires_shipping: true
checkout_business_type: 0
product_tax_included: false
checkout_template_type: 0
market_setting:
primary_market_lang: zh-CN
market_lang: zh-CN
market_id: '240715569647585064'
market_currency: USD
market_currency_symbol:
code: USD
val: $
left: $
right: ''
market_base_id: ''
market_base_currency: USD
market_base_currency_symbol:
code: USD
val: $
left: $
right: ''
primary_market_id: '240715569614047016'
primary_market_currency: USD
primary_market_currency_symbol:
code: USD
val: $
left: $
right: ''
market_price_setting:
local_currency_enabled: false
custom_rate_enabled: false
custom_rate: 0
rate: 1
back_rate: 1
actual_rate: 1
base_to_local: 0
local_to_base: 0
adjust: 0
price_round_enabled: true
market_country: CN
'404':
description: '404'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: string
examples:
- Unable to find resource
examples:
'1':
summary: Result
value:
errors:
- Unable to find resource
security:
- apikey-header-access-token: []
post:
summary: Create Order
deprecated: false
description: ''
operationId: create-order
tags:
- Order
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- tax_total
- discount
- currency_code
- shipping_address
- line_items
- shipping_line
properties:
tax_total:
type: string
description: The amount of tax, string format, e.g. "10.00"
discount:
type: string
description: Discount amount or percent for the order, discount amount cannot be greater than total price of line items, e.g. "10.00", "10%"
tags:
type: array
description: Tags of the order
items:
type: string
note:
type: string
description: Note of the order
currency_code:
type: string
description: Currency code of the order, e.g. "USD"
payment_line:
type: string
description: Payment line of the order, e.g. "COD"
shipping_address:
type: object
description: Shipping address
required:
- last_name
- email
- country
- country_code
- province
- province_code
- city
- address
properties:
first_name:
type: string
description: First name of customer
last_name:
type: string
description: Last name of customer
phone:
type: string
description: Phone number of customer
email:
type: string
description: Email of customer
country:
type: string
description: Country name, e.g. "China"
country_code:
type: string
description: Country code, e.g. "CN"
province:
type: string
description: Province name, e.g. "Guangdong"
province_code:
type: string
description: Province code, e.g. "CN-GD"
area:
type: string
description: Area name
city:
type: string
description: City name, e.g. "Shenzhen"
address:
type: string
description: Address line 1
address1:
type: string
description: Address line 2
zip:
type: string
description: Zip code
company:
type: string
description: Company name
latitude:
type: number
description: Latitude, float format, e.g. 22.54
format: float
longitude:
type: number
description: Longitude, float format, e.g. 114.06
format: float
tags:
type: array
description: Tags
items:
type: string
line_items:
type: array
description: Line items
items:
properties:
variant_id:
type: string
description: Variant's ID
product_id:
type: string
description: Product's ID
quantity:
type: integer
description: Quantity of line item
format: int32
custom_properties:
type: object
description: 'Custom properties, e.g. {"key": "value"}'
properties: {}
required:
- variant_id
- product_id
- quantity
type: object
shipping_line:
type: object
description: Shipping line
required:
- name
- shipping_price
properties:
name:
type: string
description: Name of shipping line, e.g. "Free Shipping"
desc:
type: string
description: Description of shipping line
shipping_price:
type: string
description: Shipping price, string format, e.g. "10.00", "0"
example: ''
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
order:
type: object
properties:
id:
type: string
examples:
- 11218-00000001
note:
type: string
examples:
- abc
number:
type: string
examples:
- '00000001'
financial_status:
type: string
examples:
- paid
status:
type: string
examples:
- placed
cancel_reason:
type:
- string
- 'null'
payment_method:
type: string
examples:
- online
fulfillment_status:
type: string
examples:
- partially_shipped
discount_code:
type: string
examples:
- ''
discount_applications:
type: string
examples:
- '[]'
customer_note:
type: string
examples:
- note
landing_site:
type: string
examples:
- http://www.example.com?source=abc
buyer_accepts_marketing:
type: boolean
default: true
examples:
- false
currency:
type: string
examples:
- USD
total_price:
type: string
examples:
- '16.99'
total_discount:
type: string
examples:
- '100.00'
total_tax:
type: string
examples:
- '10.00'
total_shipping:
type: string
examples:
- '1.00'
sub_total:
type: string
examples:
- '15.00'
code_discount_total:
type: string
examples:
- '1.00'
line_item_discount_total:
type: string
examples:
- '1.00'
tags:
type: string
examples:
- a, b
created_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
updated_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
canceled_at:
type:
- string
- 'null'
customer_deleted_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
deleted_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
placed_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
total_refund_price:
type: string
examples:
- '0.00'
total_refund_tax:
type: string
examples:
- '0.00'
total_refund_discount:
type: string
examples:
- '0.00'
refund_status:
type: string
examples:
- none
total_tip_received:
type: string
examples:
- '0.00'
browser_ip:
type: string
examples:
- 192.168.0.1
source:
type: string
examples:
- http://www.example.com?source=abc
last_landing_url:
type: string
examples:
- http://www.example.com?source=abc
email_status:
type: string
examples:
- send
recovery_status:
type: string
examples:
- success
total_paid:
type: string
examples:
- '16.99'
source_name:
type: object
properties:
data:
type: string
examples:
- Direct
created_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
last_referrer_show:
type: object
properties:
data:
type: string
examples:
- Others
created_at:
type: string
examples:
- '2014-04-25T16:15:47Z'
shipping_line:
type: object
properties:
name:
type: string
examples:
- free
customer:
type: object
properties:
id:
type: string
examples:
- ef0318fe-e0ed-4551-a5bc-8b8e36c4f90f
email:
type: string
examples:
- bob.norman@hostmail.com
first_name:
type: string
examples:
- Bob
last_name:
type: string
examples:
- Norman
phone:
type: string
examples:
- ''
created_at:
type: string
examples:
- '2018-11-02T12:30:10Z'
updated_at:
type: string
examples:
- '2018-11-02T12:30:10Z'
orders_count:
type: integer
default: 0
examples:
- 1
total_spent:
type: string
examples:
- '41.94'
shipping_address:
type: object
properties:
first_name:
type: string
examples:
- Bob
last_name:
type: string
examples:
- Norman
address1:
type: string
examples:
- Chestnut Street 92
address2:
type: string
examples:
- ''
phone:
type: string
examples:
- 555-625-1199
city:
type: string
examples:
- Louisville
zip:
type: string
examples:
- '40202'
province:
type: string
examples:
- Kentucky
country:
type: string
examples:
- United States
company:
type: string
examples:
- ''
latitude:
type: string
examples:
- '45.41634'
longitude:
type: string
examples:
- '-75.6868'
name:
type: string
examples:
- Bob Norman
country_code:
type: string
examples:
- US
province_code:
type: string
examples:
- US-KY
phone_area_code:
type: string
examples:
- '80'
email:
type: string
examples:
- bob.norman@hostmail.com
area:
type: string
examples:
- sz
extra_info:
type: object
properties:
cpf:
type: string
description: Tax identification number
examples:
- '123'
tax_text:
type: string
description: Tax identification number documentation
examples:
- CPF/CNPJ
id_number:
type: string
description: Identity card
examples:
- 32010219800101001X
id_number_text:
type: string
description: Identity card documentation
examples:
- ID Number
addition:
type: object
properties: {}
description: Customer customized fields
billing_address:
type: object
properties:
first_name:
type: string
examples:
- Bob
last_name:
type
# --- truncated at 32 KB (327 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shoplazza/refs/heads/main/openapi/shoplazza-order-api-openapi.yml