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

Convelio Shipping API

Shipping API allow you to request a shipping estimate from our system

Convelio Shipping API is one of 2 APIs that Convelio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.convelio.com/v2, https://api.convelio.com/v2.

4 operations 4 paths 33 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.convelio.com/v2
Authentication
API Key, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Convelio Shipping API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Convelio-signature (convelio_signature). An API key is passed in the header as Authorization (secret_token). By default, every request must be authenticated.

  • convelio_signature — An HMAC SHA256 signature created with the body data and the API secret token.
  • secret_token — token

Paths & Operations 4

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

shipping 4

Shipping API allow you to request a shipping estimate from our system

POST
/shipping/estimate/price
Shipment estimation
estimateShippingPrice 3 params body → 200401422500
POST
/shipping/quote
Request a quote
createShippingQuote 3 params body → 201400401403422500
GET
/shipping/quote/{quoteId}
Get quote
getShippingQuote 3 params → 200401403404422500
POST
/shipping/order
Create an Order
createShippingOrder 3 params body → 201400401403422500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are quote (13 properties), order (11 properties), item.base (9 properties), quote-create (8 properties). Each schema is shown below with its type and property counts.

quote-status
string
- created: The API successfully returned an instant shipping price and the quote has been created in Convelio's system. - processing: The API could not return…
measurement-system
string
Unit system used for the pickup.
quote-create
object
8 properties 3 required
direct-label-request
string
Direct label request. Possible values: - cheapestoption: API will return direct label prices if available and if direct label is the cheapest option. - directl…
billing-details
object
7 properties 4 required
country-code
string
The country code according to [iso-3166-1-alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2)
contract-insurance
boolean
You can add an Ad Valorem insurance that will compensate your prejudice in the event of damage, theft or loss (up to the declared value of your items and shipp…
item.base
object
9 properties 3 required
price
object
5 properties
currency-code
string
The currency code, according to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217)
quote
object
13 properties
packing-type
string
- notpacked: Your product is not protected by any kind of bubble warp or cardboard. - woodcrated: Your product is fully covered in bubble warp and fragile corn…
http-error
object
The error model for the API follow the Content-Type application/problem+json defined by the [IETF RFC 7807](https://tools.ietf.org/html/rfc7807). Description o…
4 properties 4 required
contact
object
6 properties 4 required
order
object
11 properties
desired-packing
string
Leave empty by default. - masterpack: Convelio will soft-wrap the item and place it into a cardboard box.
pickup
object
5 properties 2 required
http-unprocessable-entity-error
object
phone
string
Phone number with following formats: - International E.164 formats: Example: +33123123123 or +33 1 23 12 31 23 - +33: Country code with a + prefix - 123123123:…
delivery-type
string
Delivery options for the shipment. 2 possible values: - curbside: Our drivers will unload the items and deliver them in front of the building at the scheduled…
speed-shipment-estimation
string
Freight speed. Possible values: - regular speed: Our standard air freight speed option.
item-type
string
Available options: - fineart.painting: Fine art painting - fineart.picture: Fine art picture - fineart.sculpture: Fine art sculpture - fineart.installation: Fi…
item
object
Shipment Item
dimension
object
4 properties 3 required
shipping-speed
string
Freight speed. Possible values: - regularspeed: Our standard air freight speed option. - express: After our standard-service pick up and packing, your goods ta…
delivery
object
Delivery details.
5 properties 2 required
order-create
object
3 properties 1 required
address
object
5 properties 1 required
part
object
Item consisting of multiple parts
commercial-value
object
Item commercial value.
2 properties 2 required
multi-part-item
object
Item consisting of multiple parts
item-materials
array
Available options: - glass: Glass, crystal or mirror - stone: Marble, other natural stone and composites - ceramic: Ceramic, porcelain, terracotta, and earthen…
shipment-estimation
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convelio-shipping-api-openapi.yml Raw ↑

Other APIs Convelio publishes across the network.

Convelio Webhook API
Where this information came from

This is an independent, third-party profile of Convelio Shipping 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.