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

ShopGo Orders API

Order, payment and shipment management

ShopGo Orders API is one of 5 APIs that ShopGo 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, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.1.0.

Requests are made against a single base URL, https://api.shopgo.me.

5 operations 4 paths 6 schemas 2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.0
Base URL
https://api.shopgo.me/v1/management
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

ShopGo Orders API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (UserApiKey). An API key is passed in the header as X-TENANT-ID (PlatformTenant). By default, every request must be authenticated.

  • UserApiKey — Dashboard user API key (or platform master key)
  • PlatformTenant — Target tenant identifier, required only when authenticating with a platform master key. X-TENANT-NAME may be used instead.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 5

Order, payment and shipment management

GET
/v1/management/order/
Get all orders
listOrders → 200403
GET
/v1/management/order/{number}
Get order
getOrder 1 param → 200404
PATCH
/v1/management/order/{number}
Update order (authorize / cancel / visibility)
updateOrder 1 param body → 200404
POST
/v1/management/order/{number}/payment/
Create payment (or refund)
createOrderPayment 1 param body → 200
PATCH
/v1/management/order/{number}/shipment/{id}
Update shipment
updateShipment 2 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Order (17 properties), Buyer (4 properties), Payment (4 properties), Shipment (3 properties). Each schema is shown below with its type and property counts.

Error
object
Error envelope returned on non-2xx responses.
2 properties
Shipment
object
3 properties
Payment
object
A payment made to settle an order. Refunds are Payments with method=refund and a negative total.
4 properties
Order
object
Contract representing the exchange of goods or services.
17 properties 5 required
Money
object
2 properties
Buyer
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopgo-orders-api-openapi.yml Raw ↑

Other APIs ShopGo publishes across the network.

ShopGo Authentication API
ShopGo Store API
ShopGo Tenants API
ShopGo Users API
Where this information came from

This is an independent, third-party profile of ShopGo Orders 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.