Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Pick and Pack API

The Pick and Pack API provides comprehensive functionality for order management, picking operations, shipment tracking, and returns processing. The main capabilities include:

  • Retrieving detailed order information, including items, packages, and status
  • Accessing worksheet data for picking operations
  • Querying shipment tracking and delivery details
  • Getting facility information

Authentication

Orders

Worksheets

Facilities

Shipments

Common issues and solutions

In case of errors making a request, check the list of common issues and their solutions below.

1. Token expiration

  • Authentication token expires after 15 minutes.
  • Check console logs for refresh attempt.
  • Verify APIKEY_ACCOUNT format.
  • Ensure that endpoint URLs are correct.

2. Variable errors

  • Check variable syntax.
  • Validate API key format.
  • Response data might appear stale due to API caching.
  • Endpoints have a specific cache duration of 30 seconds.
  • For real-time data, consider the cache duration when implementing polling strategies.
  • Cache is based on specific parameters (e.g., orderId, shipmentId).

Endpoints

Authentication

SummaryMethodPath
Generate JWT tokenPOST/token

Orders

SummaryMethodPath
Get order by IDGET/orders/{orderId}
Set order deliveryPATCH/orders/{orderId}/tracking

Worksheets

SummaryMethodPath
Get worksheet by IDGET/worksheets/{worksheetId}
Get worksheets by order IDGET/worksheets

Facilities

SummaryMethodPath
Get facility by IDGET/facilities/{facilityId}

Shipments

SummaryMethodPath
Get shipment by shipment IDGET/shipments/{shipmentId}
List shipments by order IDGET/shipments

Loading API specification...