Order

Partner API (v1)

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

Authentication

Operations

Data

Operations

Labels

Operations

Order

Operations

Retrieves a paginated list of orders based on specified parameters.

Request

The default values for parameters are as follows:

  • PageSize: 10
  • PageNumber: 0
  • Order: "desc"
  • OrderBy: "orderId"
  • shopOrderStatus: "5"
  • includeDeleted: false
  • subOrderBy: null
  • subOrder: "desc"
Body
pageSizeinteger(int32)
pageNumberinteger(int32)
orderDirectionstring or null
orderBystring or null
shopOrderStatusinteger(int32)
includeDeletedboolean
curl -i -X POST \
  https://sandbox.bikeflights.com/api/Order/get-shop-orders \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 10,
    "pageNumber": 0,
    "orderDirection": "DESC",
    "orderBy": "orderId",
    "shopOrderStatus": 5,
    "includeDeleted": false
  }'

Responses

OK

Body
quantityinteger(int32)
orderResponseArray of objects or null(UserShipmentReport)
Response
No response example

Create shipping order

Request

Create shipping order from a request id and rate signature

Body
requestIdstring or null
rateSignaturestring or null
purchaseOrderstring or null
curl -i -X POST \
  https://sandbox.bikeflights.com/api/Order/create-shop-order \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "requestId": "string",
    "rateSignature": "string",
    "purchaseOrder": "string"
  }'

Responses

OK

PackageLocation

Operations

ShopRate

Operations