How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shoplazza Order API

The Order API from Shoplazza — 11 operation(s) for order.

Shoplazza Order API is one of 20 APIs that Shoplazza publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 11 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2022.01.

Requests are made against a single base URL, https://{subdomain}.myshoplaza.com.

16 operations 11 paths 1 schemas 1 DELETE7 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2022.01
Base URL
https://developer.myshoplaza.com/openapi/2022-01
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Shoplazza Order API declares 2 security schemes for authenticating requests. An API key is passed in the header as access-token (sec0). An API key is passed in the header as access-token (apikey-header-access-token). By default, every request must be authenticated.

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 1 DELETE, 7 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Order 16
GET
/openapi/2022-01/orders
Order List
order-list 13 params → 200404
POST
/openapi/2022-01/orders
Create Order
create-order body → 200422
GET
/openapi/2022-01/orders/{id}
Order Details
order-details 1 param → 200404
DELETE
/openapi/2022-01/orders/{id}
Delete Order
delete-order 1 param → 200404
PUT
/openapi/2022-01/orders/{id}
Update Order
update-order 1 param body → 200404
GET
/openapi/2022-01/orders/number/{number}
Get Order Details By Number
order-details-by-number 1 param → 200404
GET
/openapi/2022-01/orders/count
Order Count
order-count 7 params → 200400
POST
/openapi/2022-01/orders/{id}/cancel
Cancel Order
cancel-order 1 param body → 200404
POST
/openapi/2022-01/orders/{id}/refund
Order Refund
order-refund 1 param → 200404
GET
/openapi/2022-01/orders/{id}/refund
Refund List
refund-list 1 param → 200404
POST
/openapi/2022-01/orders/{id}/partial_refund
Partial Order Refund
partial-order-refund 1 param body → 200404
GET
/openapi/2022-01/orders/after_sales_list
After Sales List
after-sales-list 5 params → 200
POST
/openapi/2022-01/orders/{id}/close
Close Order
close-order 1 param → 200404
POST
/openapi/2022-01/orders/{id}/open
Re-Open Order
re-open-order 1 param → 200404
GET
/openapi/2022-01/orders/{id}/transactions
Transaction List
transaction-list 3 params → 200400
POST
/openapi/2022-01/orders/{id}/transactions
Create Transaction
create-transaction 1 param body → 200400

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Order (56 properties). Each schema is shown below with its type and property counts.

Order
object
56 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shoplazza-order-api-openapi.yml Raw ↑

Other APIs Shoplazza publishes across the network.

Shoplazza Access API
Shoplazza App Proxy API
Shoplazza Billing API API
Shoplazza Custom Area API
Shoplazza Customer API
Shoplazza Data API
Shoplazza Discounts API
Shoplazza File API
Shoplazza Fullfillment API
Shoplazza Gift Card API
Shoplazza Meta Definition API
Shoplazza Metafield API
Where this information came from

This is an independent, third-party profile of Shoplazza Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.