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

Beeketing Order API

An order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provide an email address or phone number, billing address and payment information. Orders can be created through the API, but no payment information will be collected, and no transaction performed. You can mark the order with any payment status

Beeketing Order API is one of 27 APIs that Beeketing 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 rate-limit docs.

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

Requests are made against a single base URL, https://shop-name.onshopbase.com.

9 operations 6 paths 27 schemas 1 DELETE3 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{shop}.onshopbase.com/admin
Authentication
API Key, API Key, API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Beeketing Order API declares 3 security schemes for authenticating requests. An API key is passed in the header as APP_ACCESS_TOKEN (APP_ACCESS_TOKEN). An API key is passed in the header as SHOP_ACCESS_TOKEN (SHOP_ACCESS_TOKEN). An API key is passed in the header as USER_ACCESS_TOKEN (USER_ACCESS_TOKEN).

Paths & Operations 9

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

Order 9

An order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they…

GET
/admin/orders.json
Retrieves a list of orders
retrieves-a-list-of-orders body → 200
POST
/admin/orders.json
Creates an order
creates-an-order body → 200
GET
/admin/orders/count.json
Retrieves an order count
retrieves-an-order-count body → 200
GET
/admin/orders/{order_id:(?:\\d+)}.json
Retrieve a single order
retrieves-a-specific-order body → 200
DELETE
/admin/orders/{order_id:(?:\\d+)}.json
Deletes an order
deletes-an-order 1 param → 200
PUT
/admin/orders/{order_id:(?:\\d+)}.json
Updates an order
updates-an-order 1 param body → 200
PUT
/admin/orders/{order_id:[0-9]+}/adjust.json
Adjust quantity or add new custom line item to order.
adjust-order body → 200
POST
/admin/orders/{order_id:[0-9]+}/cancel.json
Cancel an order
cancel-specific-order 1 param body → 200
POST
/admin/orders/{order_id:[0-9]+}/open.json
Open-Close a closed order
open-specific-order 1 param → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are OrderDto (68 properties), OrderLineItemDto (47 properties), OrderRequest (36 properties), OrdersSwaggerRequest (33 properties). Each schema is shown below with its type and property counts.

OrdersSwaggerResponse
object
1 property
ShippingLinesDto
object
8 properties
AdjustLineItemDto
object
9 properties
AdditionalInformation
object
10 properties
OrderDto
object
68 properties
TaxLineDto
object
3 properties
OrderDiscountCodeDto
object
7 properties
models.SwaggerDeleteResponse
object
OrdersSwaggerRequest
object
33 properties
RefundLineItemDto
object
10 properties
OrderSwaggerResponse
object
1 property
ClientDetailsDto
object
6 properties
FulfillmentDto
object
25 properties
CustomerAddressDetail
object
23 properties
OrderDiscountApplicationDto
object
11 properties
AppliedDiscount
object
5 properties
OrderLineItemDiscountApplicationDto
object
2 properties
cancelOrderData
object
6 properties
OrderRequest
object
36 properties
RefundDto
object
14 properties
RefundTransactionDto
object
21 properties
CountResponse
object
1 property
OrderLineItemDto
object
47 properties
RefundOrderAdjustmentDto
object
5 properties
LineItemShippingRate
object
7 properties
AdjustOrderDto
object
3 properties
Shipping
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beeketing-order-api-openapi.yml Raw ↑

Other APIs Beeketing publishes across the network.

Beeketing Abandoned Checkout API
Beeketing Balance API
Beeketing Collect API
Beeketing Custom Collection API
Beeketing Customer Address API
Beeketing Customer API
Beeketing Discount Code API
Beeketing Domain API
Beeketing Draft Order API
Beeketing Fulfillment API
Beeketing Fulfillment Service API
Beeketing Metafield API
Where this information came from

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