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 Transaction API

There are two major parts to a refund:- A record of money returned to the customer- The line items included in the refund, along with restocking instructionsBefore you create a refund, use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you're refunding shipping costs. You can then use the response in the body of the request to create the actual refund.When you create a refund using the response from the calculate endpoint, you can set additional options, such as whether to notify the customer of the refund. You can refund less than the calculated amount for either shipping or the line items by setting a custom value for the amount property.If a refund includes shipping costs, or if you choose to refund line items for less than their calculated amount, then an order adjustment is created automatically to account for the discrepancy in the store's financial reports.

Beeketing Transaction API is one of 27 APIs that Beeketing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction. 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 4 operations across 3 paths, and defines 7 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.

4 operations 3 paths 7 schemas 3 GET1 POST

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 Transaction 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 4

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

Transaction 4

There are two major parts to a refund: - A record of money returned to the customer - The line items included in the refund, along with restocking instructions Before you create a…

GET
/admin/orders/{order_id:(?:\\d+)}/transactions.json
Retrieves a list of transactions.
retrieves-a-list-of-transactions 3 params → 200
POST
/admin/orders/{order_id:(?:\\d+)}/transactions.json
Creates a transaction for an order.
creates-a-transaction-for-an-order body → 200
GET
/admin/orders/{order_id:(?:\\d+)}/transactions/count.json
Retrieves a count of an order's transactions.
retrieves-a-count-of-an-order's-transactions → 200
GET
/admin/orders/{order_id:(?:\\d+)}/transactions/{transaction_id:(?:\\d+)}.json
Retrieves a specific transaction.
retrieves-a-specific-transaction 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TransactionDto (24 properties), CurrencyExchangeAdjustmentDto (5 properties), PaymentDetailsDto (5 properties), SingleOrderTransactionSwaggerResponse (1 property). Each schema is shown below with its type and property counts.

OrderTransactionsSwaggerResponse
object
1 property
PaymentDetailsDto
object
5 properties
CountResponse
object
1 property
TransactionDto
object
24 properties
OrderTransactionSwaggerResponse
object
1 property
SingleOrderTransactionSwaggerResponse
object
1 property
CurrencyExchangeAdjustmentDto
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beeketing-transaction-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 Transaction 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.