Refurbed OrderService API
The OrderService API from Refurbed — 13 operation(s) for orderservice.
Refurbed OrderService API is one of 18 APIs that Refurbed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include OrderService. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 13 operations across 13 paths, and defines 75 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.refurbed.com.
13 operations
13 paths
75 schemas
13 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Refurbed OrderService 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 13
Across 13 paths, the API surfaces 13 operations — 13 POST. Each is listed below with its method, path, parameters, and response codes.
OrderService 13
POST
/refb.merchant.v1.OrderService/CalculateRefundOrder
Calculate values for a refund of all refundable items of an order at once, i.e. using the RefundOrder method.
POST
/refb.merchant.v1.OrderService/CreateShippingLabel
Creates shipping label for an order
POST
/refb.merchant.v1.OrderService/DeleteOrderCommercialInvoice
Deletes the previously uploaded commercial invoice for an order.
POST
/refb.merchant.v1.OrderService/DeleteOrderInvoice
Deletes the order's invoice. Order needs to be invoiceable.
POST
/refb.merchant.v1.OrderService/GetOrder
Gets a single order using its identifier.
POST
/refb.merchant.v1.OrderService/GetOrderCommercialInvoice
Returns the previously uploaded commercial invoice for an order.
POST
/refb.merchant.v1.OrderService/GetOrderInvoice
Gets the order's invoice. The URL access token is valid for 24h.
POST
/refb.merchant.v1.OrderService/ListOrders
Lists orders.
POST
/refb.merchant.v1.OrderService/ListShippingLabels
Lists shipping labels for an order
POST
/refb.merchant.v1.OrderService/RefundOrder
Refunds all refundable items of an order at once.
POST
/refb.merchant.v1.OrderService/SetOrderInvoiceStream
Uploads an invoice for an order.
POST
/refb.merchant.v1.OrderService/UpdateShippingLabelAddress
Updates the shipping label address for an order.
POST
/refb.merchant.v1.OrderService/UploadOrderCommercialInvoice
Uploads a commercial invoice for an order.
Schemas 75
The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are OrderItem (40 properties), ListOrdersRequest.Filter (28 properties), Order (27 properties), MerchantAddress (14 properties). Each schema is shown below with its type and property counts.
UpdateShippingLabelAddressRequest.Address
object
10 properties
6 required
TrackingData
object
3 properties
CalculateRefundOrderResponse
object
6 properties
AddressEntity
string
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
OrderStateFilter
object
2 properties
Int64Pagination
object
Paginates resources with int64 primary key.
3 properties
DeleteOrderInvoiceRequest
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…
OrderState
string
Order states are calculated based on the individual order item states. - NEW: Order was not handled yet. At least one order item has state NEW. - REJECTED: Ord…
SetOrderInvoiceRequest.Meta
object
1 property
1 required
ListOrdersRequest.Sort.By
string
RefundOrderRequest
object
1 property
1 required
GetOrderCommercialInvoiceRequest
object
1 property
1 required
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.
OrderAddressFilter
object
1 property
BoolFilter
object
1 property
UpdateShippingLabelAddressRequest
object
2 properties
1 required
AddressEntityFilter
object
2 properties
GetOrderRequest
object
1 property
1 required
UploadOrderCommercialInvoiceRequest.Meta
object
2 properties
2 required
SetOrderInvoiceRequest
array
Send first message with Meta set, then other messages with chunked data to stream. Max total data size is 2MB (2 1024^2 bytes).
2 properties
GetOrderInvoiceRequest
object
1 property
1 required
UploadOrderCommercialInvoiceResponse
object
3 properties
OrderItemTaxation
string
CountryCodeFilter
object
2 properties
CarrierEnum.Carrier
string
BatteryCondition
string
MerchantAddress
object
MerchantAddress is the address from which the merchant dispatches shipments. Used as the merchant's shipping address in the context of shipping label creation.
14 properties
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/…
OrderItem
object
An order item.
40 properties
ListOrdersRequest.Filter
object
28 properties
SortOrder
string
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…
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…
GetOrderInvoiceResponse
object
1 property
OrderItemIdentifier
object
2 properties
GetOrderResponse
object
1 property
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
RefundOrderResponse
object
6 properties
ListOrdersRequest.Sort
object
2 properties
GetOrderCommercialInvoiceResponse
object
2 properties
SetOrderInvoiceResponse
object
3 properties
ListOrdersResponse
object
2 properties
CreateShippingLabelResponse
object
1 property
TimestampRangeFilter
object
6 properties
OrderCustomerEmailFilter
object
2 properties
OrderLabelCollectionFilter
object
3 properties
UpdateShippingLabelAddressResponse
object
1 property
OfferSKUFilter
object
3 properties
Order
object
An order.
27 properties
PaymentMethod
string
OrderLabel
string
Labels are additional indicators set next to the order state. They can be filtered by. - PROCESSING: Set if the items' states of an order are neither all state…
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
OrderAddressVATINFilter
object
2 properties
OrderAddressPhoneNumberFilter
object
2 properties
MerchantAddressType
string
DeleteOrderCommercialInvoiceRequest
object
1 property
1 required
UploadOrderCommercialInvoiceRequest
array
Send first message with Meta set, then other messages with chunked data to stream. Max total data size is 2MB (2 1024^2 bytes).
2 properties
CurrencyCode
string
Currency codes as specified in ISO 4217. - AED: XTS = 963; // Code reserved for testing purposes.
NormalPrinterURLs
object
4 properties
Int64Filter
object
2 properties
ShippingLabel
object
ShippingLabel represents a shipping label for parcel.
6 properties
CurrencyCodeFilter
object
2 properties
ListShippingLabelsRequest
object
1 property
1 required
CalculateRefundOrderRequest
object
1 property
1 required
ListShippingLabelsResponse
object
1 property
ListOrdersRequest
object
3 properties
OrderItemIdentifierType
string
ListOrdersRequest.Filter.OrderItemNameFilter
object
1 property
v1.Address
object
13 properties
CreateShippingLabelRequest
object
4 properties
3 required
OfferData
object
9 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Refurbed 12
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
#OrderService