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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ShopBack

ShopBack Orders API

The Orders API from ShopBack — 8 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

ShopBack Orders API is one of 5 APIs that ShopBack 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, an API reference, authentication docs, and a getting-started guide.

This API exposes 8 operations across 8 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://integrations-sandbox.shopback.com, https://integrations-sandbox.shopback.com/demo/merchant.

8 operations 8 paths 27 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://prod-merchant-service.hoolah.co/merchant
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ShopBack Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

  • bearer — Merchant JWT obtained from POST /merchant-gateway/auth/login.

Paths & Operations 8

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

Orders 8
POST
/posi-sandbox/v1/instore/order/{referenceId}/cancel
Cancel order
Cancel order 4 params body → 200400401404409
POST
/posi-sandbox/v1/instore/order/create
Create order - QR / URL (dynamic)
Create dynamic QR order 3 params body → 200400401404409
GET
/posi-sandbox/v1/instore/order/{referenceId}
Get order status
Get order status 4 params → 200400401404409
POST
/posi-sandbox/v1/instore/order/{referenceId}/refund
Order refund
Order refund 4 params body → 200400401404409
POST
/posi-sandbox/v1/instore/order/scan
Scan consumer QR
Scan consumer QR 3 params body → 200400401404409
GET
/order/{uuid}
Get order status
getOrderInfo 3 params → 200404412500
POST
/order/initiate
Create order
initiateOrder 2 params body → 200404412500
POST
/order/{orderUuid}/refund
Order refund
initiateOrderRefund 3 params body → 200404412500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are InitiateOnlineOrderRequest (27 properties), ShippingAddressRequest (17 properties), BillingAddressRequest (17 properties), GetOrderDetailsResDto (13 properties). Each schema is shown below with its type and property counts.

OrderItemRequest
object
13 properties 1 required
SandboxCreateOrderReqDto
object
9 properties 6 required
SandboxScanOrderReqDto
object
9 properties 6 required
RRVResponseModel
object
7 properties 4 required
PartialRefundItemRequestModel
object
1 property 1 required
OrderItemImageRequest
object
1 property 1 required
ShippingAddressRequest
object
17 properties
ResouceConflictDto
object
3 properties 3 required
PartnerMerchantInfoRequest
object
4 properties 1 required
CreateOrderResDto
object
6 properties 4 required
SandboxRefundOrderReqDto
object
5 properties 2 required
RRVResponseDetailsModel
object
2 properties 2 required
SandboxCancelOrderReqDto
object
1 property
InitiateOnlineOrderRequest
object
27 properties 5 required
GetOrderDetailsResDto
object
13 properties 10 required
RefundOrderResDto
object
5 properties 3 required
PartialRefundRequestModel
object
5 properties 2 required
InitiatedOrderResponse
object
3 properties 1 required
NotFoundResDto
object
3 properties 3 required
CancelOrderResDto
object
2 properties 2 required
BillingAddressRequest
object
17 properties
AdditionalOrderMetadata
object
2 properties
BadReqDto
object
3 properties 3 required
MerchantOrderResponse
object
10 properties 9 required
UnauthorizedDto
object
3 properties 3 required
ErrorResponse
object
7 properties
AdditionalrefundMetadata
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopback-orders-api-openapi.yml Raw ↑

Other APIs ShopBack publishes across the network.

ShopBack Account Linking API
AE Profile APIs.io
ShopBack Authentication API
AE Profile APIs.io
ShopBack Notification API
AE Profile APIs.io
ShopBack Pre Auth API
AE Profile APIs.io
#Order
← Back to S APIs
API Details
ID
shopback:shopback-orders-api
Base URL
https://prod-merchant-service.hoolah.co/merchant
Docs
https://docs.shopback.com/reference/initiateorder
Provider
ShopBack
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=shopback-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/shopback-orders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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