Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Refurbed OrderItemService API

The OrderItemService API from Refurbed — 8 operation(s) for orderitemservice.

Refurbed OrderItemService API is one of 18 APIs that Refurbed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OrderItemService. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against the base URL https://api.refurbed.com.

8 operations 8 paths 52 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.refurbed.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Refurbed OrderItemService API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (APIKeyAuth). By default, every request must be authenticated.

Paths & Operations 8

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

OrderItemService 8
POST
/refb.merchant.v1.OrderItemService/BatchUpdateOrderItems
Batch updates order items.
BatchUpdateOrderItems 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/BatchUpdateOrderItemsState
Batch updates order items' state.
BatchUpdateOrderItemsState 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/CalculateRefundOrderItem
Calculate values for a refund of a single order item, i.e. using the RefundOrderItem method.
CalculateRefundOrderItem 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/GetOrderItem
Gets a single order item.
GetOrderItem 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/ListOrderItemsByOrder
Lists all order items of a specific order.
ListOrderItemsByOrder 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/RefundOrderItem
Refunds a single order item. Item needs to be refundable.
RefundOrderItem 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/UpdateOrderItem
Updates a single order item.
UpdateOrderItem 1 param → 200default
POST
/refb.merchant.v1.OrderItemService/UpdateOrderItemState
Updates the state of a single order item.
UpdateOrderItemState 1 param → 200default

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are OrderItem (40 properties), ListOrderItemsByOrderRequest.Filter (27 properties), UpdateOrderItemStateRequest (9 properties), BatchUpdateOrderItemsStateRequest.Update (9 properties). Each schema is shown below with its type and property counts.

GetOrderItemRequest
object
1 property 1 required
NumericRangeFilter
object
Numeric range filter is used for decimal numbers. It is especially used for monetary amounts and other quantities where exactness is required.
6 properties
Int64Pagination
object
Paginates resources with int64 primary key.
3 properties
OfferWarranty
string
The warranty the merchant provides to the customer. Only 12 months is supported. - M12: 12 months. - M18: 18 months, deprecated. Only 12 months is supported fo…
CalculateRefundOrderItemRequest
object
3 properties 2 required
OrderItemStateFilter
object
2 properties
OfferGrading
string
The grading of the item being sold. Please consult the refurbed seller guide and quality charta to learn about refurbed's grading requirements.
GetOrderItemResponse
object
1 property
BoolFilter
object
1 property
BatchUpdateOrderItemsRequest
object
1 property 1 required
BatchUpdateOrderItemsStateRequest
object
1 property 1 required
ListOrderItemsByOrderRequest.Filter.OrderItemNameFilter
object
1 property
ListOrderItemsByOrderResponse
object
2 properties
BatchUpdateOrderItemsRequest.Update
object
8 properties 1 required
OrderItemTaxation
string
OrderItemShipmentSubstatus
string
- INFORECEIVED: The carrier received a request from the shipper and is about to pick up the shipment. - LABELCREATEDNOUPDATESYET: The order has been processed/…
BatteryCondition
string
Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
OrderItem
object
An order item.
40 properties
OrderItemShipmentStatus
string
- INFORECEIVED: Carrier has received request from shipper and is about to pick up the shipment. - INTRANSIT: Carrier has accepted or picked up shipment from sh…
SortOrder
string
CountryCode
string
Alpha-2 country codes as specified in ISO 3166-1.
RefundEligibility
string
- ELIGIBLE: Refunds are allowed. - INELIGIBLEUNKNOWN: Refunds are not allowed for an unspecified reason. - INELIGIBLEPERIODEXPIRED: Refunds are not allowed bec…
OrderItemState
string
- NEW: Order item was not handled yet. Next states: REJECTED, CANCELLED or ACCEPTED. - REJECTED: Order item cannot be fulfilled. Final state. - CANCELLED: Orde…
OrderItemIdentifier
object
2 properties
OfferGradingFilter
object
2 properties
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
UpdateOrderItemRequest
object
8 properties 1 required
BatchUpdateOrderItemsResponse
object
1 property
UpdateOrderItemResponse
object
1 property
UpdateOrderItemStateRequest
object
9 properties 1 required
ListOrderItemsByOrderRequest.Filter
object
27 properties
OfferSKUFilter
object
3 properties
OrderItemTaxationFilter
object
2 properties
BatchUpdateOrderItemsStateRequest.Update
object
9 properties 1 required
BatchUpdateOrderItemsStateResponse.Result
object
2 properties
CalculateRefundOrderItemResponse
object
6 properties
CarrierTrackingNumber
object
2 properties
CurrencyCode
string
Currency codes as specified in ISO 4217. - AED: XTS = 963; // Code reserved for testing purposes.
BatchUpdateOrderItemsStateResponse
object
1 property
Int64Filter
object
2 properties
ListOrderItemsByOrderRequest.Sort
object
2 properties
OfferWarrantyFilter
object
2 properties
ListOrderItemsByOrderRequest.Sort.By
string
CurrencyCodeFilter
object
2 properties
RefundOrderItemRequest
object
3 properties 2 required
OrderItemIdentifierType
string
ListOrderItemsByOrderRequest
object
4 properties 1 required
UpdateOrderItemStateResponse
object
1 property
BatchUpdateOrderItemsResponse.Result
object
2 properties
RefundOrderItemResponse
object
6 properties
OfferData
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

refurbed-orderitemservice-api-openapi.yml Raw ↑

Other APIs Refurbed publishes across the network.

Refurbed BuybackBidService API
Refurbed BuybackOrderItemService API
Refurbed BuybackOrderService API
Refurbed BuybackProductService API
Refurbed BuybackSupplyboxService API
Refurbed CatalogService API
Refurbed CurrencyService API
Refurbed InstanceService API
Refurbed MarketOfferService API
Refurbed MarketService API
Refurbed MerchantService API
Refurbed OfferService API