Labels
/
Get the label associated with a tracking number

Partner API (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Sandbox server
https://sandbox.bikeflights.com/

Authentication

Operations

Data

Operations

Labels

Operations

Create labels associated with an order id

Request

Create shipping label from order id. The order id is received from the order/create-shop-order endpoint

Path
orderIdinteger(int32)required
curl -i -X POST \
  'https://sandbox.bikeflights.com/api/Labels/create-shop-label/{orderId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Body
Array [
labelResponseobject(AutoLabelResponse)
errorResponseobject(ShipmentErrorResponse)
]
Response
No response example

Get the label associated with a tracking number

Request

Get previously created shipping labels, call create-shop-labels first

Path
trackingNumberstringrequired

Shipping provider tracking number

labelTypestringrequired

Options are "laser" or "thermal" depending on your needs

Default "laser"
curl -i -X GET \
  'https://sandbox.bikeflights.com/api/Labels/shop-label/{trackingNumber}/{labelType}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Order

Operations

PackageLocation

Operations

ShopRate

Operations