BoekUwZending TypeScript API Client
Unofficial TypeScript API client for the BoekUwZending API.
npm install boekuwzending-api
yarn add boekuwzending-api
import BoekUwZending, { ClientConfig } from "boekuwzending-api"
const config: ClientConfig = {
clientId: "[CLIENT_ID]", // required
clientSecret: "[CLIENT_SECRET]" // required
mode: "production" | "staging" // optional, defaults to "production"
}
const client = await BoekUwZending.create(config)
const { data: externalOrders, error: _ } = await client.endpoints.externalOrders.get({
_items_per_page: 10,
_page: 1
})
API Implementation Status
Endpoint |
GET |
POST |
PUT |
DELETE |
/me |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/orders |
✅ |
✅ |
- |
- |
/orders/{id} |
✅ |
- |
✅ |
✅ |
Endpoint |
GET |
POST |
PUT |
DELETE |
/users |
✅ |
✅ |
- |
- |
/users/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/admin_users |
✅ |
- |
- |
- |
/admin_users/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/address_book_items |
✅ |
- |
- |
- |
/address_book_items/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/bulk_shipments |
✅ |
- |
- |
- |
/bulk_shipments/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/buzzie/postcodes |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/conversations |
✅ |
✅ |
- |
- |
/conversations/{id} |
✅ |
- |
- |
- |
/conversations/{id}/messages |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/countries |
✅ |
- |
- |
- |
/countries/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/distributors |
✅ |
- |
- |
- |
/distributors/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/integrations |
✅ |
- |
- |
- |
/integrations/shopify |
- |
✅ |
- |
- |
/integrations/shopify/{id} |
✅ |
- |
- |
- |
/integrations/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/labels/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/matrices |
✅ |
- |
- |
- |
/matrices/{id} |
✅ |
- |
- |
- |
/matrix_groups |
✅ |
- |
- |
- |
/matrix_groups/{id} |
✅ |
- |
- |
- |
/matrix_postcodes |
✅ |
- |
- |
- |
/matrix_postcodes/{id} |
✅ |
- |
- |
- |
/matrix_rates |
✅ |
- |
- |
- |
/matrix_rates/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/messages |
- |
✅ |
- |
- |
/messages/{id} |
✅ |
- |
✅ |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/pickup_requests |
✅ |
✅ |
- |
- |
- |
/pickup_requests/{id} |
✅ |
- |
✅ |
✅ |
✅ |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/rate-request |
- |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/relations |
✅ |
- |
- |
- |
/relations/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/scan_inbounds |
- |
✅ |
- |
- |
/scan_inbounds/{uuid} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/services |
- |
✅ |
- |
- |
/services/{id} |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
/shipment_quotations |
✅ |
- |
- |
- |
/shipment_quotations/{id} |
✅ |
- |
- |
- |
/shipments |
✅ |
✅ |
- |
- |
/shipments/items/{id} |
✅ |
- |
- |
- |
/shipments/{id} |
✅ |
- |
- |
- |
/shipments/{id}/labels |
✅ |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/surcharge_sets/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/track-and-trace/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/trackings |
✅ |
- |
- |
- |
- |
/trackings/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/types |
✅ |
- |
- |
- |
- |
/types/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/webhooks |
✅ |
✅ |
- |
- |
- |
/webhooks/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/widgets |
✅ |
- |
- |
- |
- |
/widgets/{id} |
✅ |
- |
- |
- |
- |
Endpoint |
GET |
POST |
PUT |
DELETE |
PATCH |
/transport/depots |
✅ |
✅ |
- |
- |
- |
/transport/depots/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/drivers |
✅ |
✅ |
- |
- |
- |
/transport/drivers/{id} |
✅ |
- |
✅ |
✅ |
✅ |
/transport/excluded_pickups |
✅ |
✅ |
- |
- |
- |
/transport/excluded_pickups/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/pickup_requests |
✅ |
✅ |
- |
- |
- |
/transport/pickup_requests/{id} |
✅ |
- |
✅ |
✅ |
✅ |
/transport/pickup_schedules |
✅ |
✅ |
- |
- |
- |
/transport/pickup_schedules/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/pickups |
✅ |
- |
- |
- |
- |
/transport/pickups/{id} |
✅ |
- |
- |
- |
- |
/transport/positions |
✅ |
✅ |
- |
- |
- |
/transport/positions/{id} |
✅ |
- |
- |
- |
- |
/transport/postcodes |
✅ |
✅ |
- |
- |
- |
/transport/postcodes/{id} |
✅ |
- |
✅ |
✅ |
✅ |
/transport/regions |
✅ |
✅ |
- |
- |
- |
/transport/regions/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/route_collection_bulks |
❌ |
❌ |
- |
- |
- |
/transport/route_collection_bulks/{id} |
❌ |
- |
❌ |
- |
❌ |
/transport/route_collection_vehicles |
❌ |
❌ |
- |
- |
- |
/transport/route_collection_vehicles/{id} |
❌ |
- |
❌ |
❌ |
❌ |
/transport/route_collections |
✅ |
✅ |
- |
- |
- |
/transport/route_collections/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/route_collections/{id}/route_collection_bulks |
❌ |
- |
- |
- |
- |
/transport/route_collections/{id}/route_collection_vehicles |
❌ |
- |
- |
- |
- |
/transport/route_collections/{id}/routes |
❌ |
- |
- |
- |
- |
/transport/route_collections/{id}/routes/{routes}/steps |
❌ |
- |
- |
- |
- |
/transport/route_collections/{id}/unassigneds |
❌ |
- |
- |
- |
- |
/transport/routes |
✅ |
- |
- |
- |
- |
/transport/routes/{id} |
✅ |
- |
✅ |
- |
✅ |
/transport/routes/{id}/steps |
✅ |
- |
- |
- |
- |
/transport/statuses |
✅ |
✅ |
- |
- |
- |
/transport/statuses/{id} |
✅ |
- |
- |
- |
- |
/transport/steps |
✅ |
- |
- |
- |
- |
/transport/steps/{id} |
✅ |
- |
- |
✅ |
- |
/transport/task_activities |
✅ |
- |
- |
- |
- |
/transport/task_activities/{id} |
✅ |
- |
- |
- |
- |
/transport/task_labels |
✅ |
- |
- |
- |
- |
/transport/task_labels/{id} |
✅ |
- |
✅ |
- |
- |
/transport/task_pickups |
✅ |
- |
- |
- |
- |
/transport/task_pickups/{id} |
✅ |
- |
✅ |
- |
- |
/transport/tasks |
✅ |
- |
- |
- |
- |
/transport/tasks/{id} |
✅ |
- |
✅ |
- |
- |
/transport/unassigned_labels |
❌ |
- |
- |
- |
- |
/transport/unassigned_labels/{id} |
❌ |
- |
- |
- |
- |
/transport/unassigned_pickups |
❌ |
- |
- |
- |
- |
/transport/unassigned_pickups/{id} |
❌ |
- |
- |
- |
- |
/transport/unassigned_shipments |
❌ |
- |
- |
- |
- |
/transport/unassigned_shipments/{id} |
❌ |
- |
- |
- |
- |
/transport/unassigneds |
❌ |
- |
- |
- |
- |
/transport/unassigneds/{id} |
❌ |
- |
- |
- |
- |
/transport/vehicles |
❌ |
❌ |
- |
- |
- |
/transport/vehicles/{id} |
❌ |
- |
❌ |
❌ |
❌ |
/transport/warehouse/{waybill}/info |
❌ |
- |
- |
- |
- |
/transport/warehouse_informations |
❌ |
- |
- |
- |
- |