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 Refund 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 Refund API is one of 27 APIs that Beeketing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Refund. 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 33 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 33 schemas 2 GET2 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 Refund 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 — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Refund 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:[0-9]+}/refunds.json
Retrieves a list of refunds for an order.
retrieves-a-list-of-refunds-for-an-order → 200
POST
/admin/orders/{order_id:[0-9]+}/refunds.json
Creates a refund
create-the-refund body → 200
POST
/admin/orders/{order_id:[0-9]+}/refunds/calculate.json
Calculate the refund
calculate-the-refund body → 200
GET
/admin/orders/{order_id:[0-9]+}/refunds/{refund_id:[0-9]+}.json
Retrieve a specific refund
retrieve-a-specific-refund → 200

Schemas 33

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

Request
object
12 properties
ShippingLinesDto
object
8 properties
CalculateRequest
object
3 properties
CalculateResponse
object
7 properties
CalculateLineItemResponse
object
14 properties
RefundSeller
object
8 properties
RetrievesListRefundsSwaggerResponse
object
2 properties
AdditionalInformation
object
10 properties
OrderDto
object
68 properties
RetrievesRefundsSwaggerResponse
object
1 property
TaxLineDto
object
3 properties
OrderDiscountCodeDto
object
7 properties
CalculateShippingResponse
object
3 properties
CalculateRefundSwaggerResponse
object
1 property
RefundLineItemDto
object
10 properties
ClientDetailsDto
object
6 properties
FulfillmentDto
object
25 properties
CustomerAddressDetail
object
23 properties
OrderDiscountApplicationDto
object
11 properties
AppliedDiscount
object
5 properties
CalculateRequestBody
object
1 property
OrderLineItemDiscountApplicationDto
object
2 properties
CalculateTransactionResponse
object
9 properties
RefundDto
object
14 properties
RefundTransactionDto
object
21 properties
Transactions
object
4 properties
OrderLineItemDto
object
47 properties
RefundOrderAdjustmentDto
object
5 properties
LineItemShippingRate
object
7 properties
Shipping
object
2 properties
RefundSwaggerResponse
object
1 property
createRefundRequestBody
object
1 property
RefundLineItem
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beeketing-refund-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 Refund 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.