Postman Collection
Using Postman to Test Biteship API
To make testing easier, you can use the Postman collection for Biteship API. Follow the steps below to set it up:
Download the Postman Collection: Download biteship.postman_collection.json.
Import it into Postman:
- Open Postman, click Import, and select the downloaded file.
- The requests are grouped in the order of a typical integration: Maps, Couriers, Rates, Locations, Draft Order, Order, Tracking and Shipping Label.
Set Your API Key:
- Open the collection, go to the Variables tab, and put your API key in the Current value of
BITESHIP_API_KEY. - Use a Test API key (
biteship_test.…) while you try things out. Orders made with it are simulated. See Sandbox Environment. - Keep the key in Current value only. The Initial value is shared when the collection is exported or synced.
- Every request already uses
https://api.biteship.comand sends the key in theAuthorizationheader. See Authentication.
- Open the collection, go to the Variables tab, and put your API key in the Current value of
Testing the API:
- You can now use the Postman collection to test various endpoints of the Biteship API.
- Each request has a description, and most have saved examples of requests and responses.