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

The ShippingProfileService API from Refurbed — 6 operation(s) for shippingprofileservice.

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

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

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

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

6 operations 6 paths 34 schemas 6 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 ShippingProfileService 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 6

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

ShippingProfileService 6
POST
/refb.merchant.v1.ShippingProfileService/CreateShippingProfile
Creates a shipping profile.
CreateShippingProfile 1 param → 200default
POST
/refb.merchant.v1.ShippingProfileService/DeleteShippingProfile
Deletes a shipping profile. Only shipping profiles marked as deletable can be deleted.
DeleteShippingProfile 1 param → 200default
POST
/refb.merchant.v1.ShippingProfileService/GetShippingProfile
Gets a single shipping profile. If no version is defined, its current version is returned.
GetShippingProfile 1 param → 200default
POST
/refb.merchant.v1.ShippingProfileService/ListAvailableCarriers
Lists available carriers for shipping profiles. Make sure to pre-fetch and cache the response of this method to avoid running into rate-limits.
ListAvailableCarriers 1 param → 200default
POST
/refb.merchant.v1.ShippingProfileService/ListShippingProfiles
Lists all current shipping profiles.
ListShippingProfiles 1 param → 200default
POST
/refb.merchant.v1.ShippingProfileService/UpdateShippingProfile
Updates a shipping profile.
UpdateShippingProfile 1 param → 200default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are MerchantAddress (14 properties), Destination (12 properties), ShippingProfile (11 properties), UpdateShippingProfileRequest.Address (10 properties). Each schema is shown below with its type and property counts.

ListShippingProfilesRequest.Sort.By
string
ListShippingProfilesRequest.Filter
object
6 properties
Int64Pagination
object
Paginates resources with int64 primary key.
3 properties
ListAvailableCarriersResponse
object
1 property
CreateShippingProfileRequest.Address
object
10 properties 5 required
ShippingProfile
object
A shipping profile defines from where a parcel will be shipped, and in what markets it will be made available and under what conditions.
11 properties
Destination
object
12 properties
UpdateShippingProfileRequest
object
See shipping profile for full documentation.
7 properties 1 required
v1.Carrier
object
2 properties
UpdateShippingProfileRequest.CreateDestination
object
8 properties 4 required
ListShippingProfilesResponse
object
2 properties
GetShippingProfileResponse
object
1 property
CreateShippingProfileRequest
object
See shipping profile for full documentation.
4 properties 2 required
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
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
CreateShippingProfileResponse
object
1 property
UpdateShippingProfileResponse
object
1 property
SortOrder
string
CountryCode
string
Alpha-2 country codes as specified in ISO 3166-1.
UInt32RangeFilter
object
6 properties
ListShippingProfilesRequest.Sort
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
TimestampRangeFilter
object
6 properties
ShippingProfileNameFilter
object
1 property
ListShippingProfilesRequest
object
3 properties
UpdateDestination
object
8 properties 1 required
MerchantAddressType
string
CurrencyCode
string
Currency codes as specified in ISO 4217. - AED: XTS = 963; // Code reserved for testing purposes.
UpdateShippingProfileRequest.Address
object
10 properties 5 required
Int64Filter
object
2 properties
StringFilter
object
2 properties
CreateShippingProfileRequest.CreateDestination
object
8 properties 4 required
DeleteShippingProfileRequest
object
1 property 1 required
GetShippingProfileRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

refurbed-shippingprofileservice-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