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

The OfferService API from Refurbed — 9 operation(s) for offerservice.

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

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

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

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

9 operations 9 paths 67 schemas 9 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 OfferService 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 9

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

OfferService 9
POST
/refb.merchant.v1.OfferService/BatchCreateOffers
Batch creates offers.
BatchCreateOffers 1 param → 200default
POST
/refb.merchant.v1.OfferService/BatchDeleteOffers
Batch deletes offers.
BatchDeleteOffers 1 param → 200default
POST
/refb.merchant.v1.OfferService/BatchGetOffers
Batch gets single offers.
BatchGetOffers 1 param → 200default
POST
/refb.merchant.v1.OfferService/BatchUpdateOffers
Batch updates offers.
BatchUpdateOffers 1 param → 200default
POST
/refb.merchant.v1.OfferService/CreateOffer
Creates a single offer.
CreateOffer 1 param → 200default
POST
/refb.merchant.v1.OfferService/DeleteOffer
Deletes a single offer.
DeleteOffer 1 param → 200default
POST
/refb.merchant.v1.OfferService/GetOffer
Gets a single offer.
GetOffer 1 param → 200default
POST
/refb.merchant.v1.OfferService/ListOffers
Lists all offers.
ListOffers 1 param → 200default
POST
/refb.merchant.v1.OfferService/UpdateOffer
Updates a single offer.
UpdateOffer 1 param → 200default

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are Offer (24 properties), ListOffersRequest.Filter (16 properties), BatchCreateOffersRequest.Create (16 properties), OfferMarketPrice (15 properties). Each schema is shown below with its type and property counts.

ListOffersRequest.Sort
object
2 properties
OfferState
string
- OK: Everything is in order. Final state. - UNVERIFIED: Offer needs to be verified in the refurbed merchant interface before being shown publicly. This state…
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
Create.CreateMarketPrice
object
4 properties 2 required
BatchCreateOffersResponse.Result
object
2 properties
LanguageCode
string
BatchUpdateOffersRequest.Update
object
12 properties
Int64Pagination
object
Paginates resources with int64 primary key.
3 properties
BatchDeleteOffersResponse
object
1 property
BatchGetOffersRequest
object
1 property 1 required
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…
Offer
object
A merchant's offer.
24 properties
OfferTaxationFilter
object
2 properties
RejectionReason
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.
OfferBuyboxState
string
- WON: Offer currently has the BuyBox. - SHOULDWIN: Current offer configuration should win the BuyBox on next refresh. - ELIGIBLE: Offer currently does not hav…
BatteryConditionFilter
object
3 properties
GetOfferResponse
object
1 property
OptionalNumericRangeFilter
object
Numeric range filter is used for decimal numbers. It is especially used for monetary amounts and other quantities where exactness is required.
7 properties
UpdateOfferResponse
object
1 property
BatchDeleteOffersResponse.Result
object
1 property
BatchUpdateOffersRequest
object
See offer for full documentation.
1 property 1 required
OfferStateFilter
object
2 properties
BatchCreateOffersRequest
object
See offer for full documentation.
1 property 1 required
BatchUpdateOffersResponse.Result
object
2 properties
BatchGetOffersRequest.Get
object
1 property
OfferBuyboxScope
string
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
BatchDeleteOffersRequest
object
1 property 1 required
BuyboxInfo
object
5 properties
SortOrder
string
UpdateOfferRequest
object
See offer for full documentation.
12 properties
BatchDeleteOffersRequest.Delete
object
1 property
UInt32RangeFilter
object
6 properties
OptionalInt64Filter
object
3 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
InstanceDescriptor
object
5 properties 2 required
OfferMarketPrice
object
An offer price defines the price configuration of an offer for a single market.
15 properties
BatchGetOffersResponse
object
1 property
MatchingHints
object
4 properties
TimestampRangeFilter
object
6 properties
ListOffersRequest
object
3 properties
CreateOfferRequest
object
See offer for full documentation.
15 properties 4 required
OfferSKUFilter
object
3 properties
BatchCreateOffersRequest.Create
object
16 properties 4 required
OfferVisibility
string
Indicates if and how an offer is shown on the refurbed platform. - FULL: Offer is normally shown to customers. - NONE: Offer is not shown to customers (e.g. do…
OfferTaxation
string
GetOfferRequest
object
1 property
BatchGetOffersResponse.Result
object
2 properties
RejectionCategory
string
- MISSINGREQUIREMENTS: Some of the mandatory parameters to determine what product the offer describes are missing - CONFIGURATIONDOESNOTEXIST: Product configur…
ListOffersRequest.Filter
object
16 properties
OfferIdentifier
object
2 properties
CurrencyCode
string
Currency codes as specified in ISO 4217. - AED: XTS = 963; // Code reserved for testing purposes.
Int64Filter
object
2 properties
Specification
object
2 properties 2 required
BatchUpdateOffersResponse
object
1 property
OfferWarrantyFilter
object
2 properties
DeleteOfferRequest
object
1 property
CurrencyCodeFilter
object
2 properties
ListOffersResponse
object
2 properties
CreateOfferResponse
object
1 property
CreateOfferRequest.CreateMarketPrice
object
4 properties 2 required
ListOffersRequest.Sort.By
string
BatchCreateOffersResponse
object
1 property
ListOffersRequest.Filter.OfferNameFilter
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

refurbed-offerservice-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 OrderItemReturnService API