Shippit needs to know the specifications of the products you want shipped and what parcels to use in shipping them. This is used to stand for a service level such as standard, express, priority, click_and_collect. To have Shippit allocate the courier for you, pass the courier_type field to specify the type of couriers that Shippit can choose from to allocate for you. To manually specify a courier, pass the courier_allocation field with the identifier of the courier (see below). You can allocate a courier to an order in one of two ways: you can manually specify the courier as part of the order, or you can allow Shippit to automatically allocate a courier for you. If a valid combination is not found, Shippit will return a suggested address. If the validate field is passed and set to true, then the order is not saved unless Shippit can validate the destination suburb and postcode to be a valid combination. Priority and Ondemand orders will remain on the New Orders page until dismissed by clicking the Label button or the GET label API call is made. Ondemand orders are automatically booked by Shippit for an ASAP pickup, respecting store pick-and-pack time. They are automatically booked by Shippit on the delivery date. Unlike standard / express orders, priority and ondemand orders do not need the book call. Priority and Ondemand Order Lifecycle Web UI action They remain in the New Orders page until you call either the Book API or click the Label button. Unlike standard / express orders, click and collect orders do not proceed to the Ready to Ship page. Order Lifecycle Standard and Express Lifecycle Web UI actionĬlick and Collect Lifecycle Web UI action There is a maximum of 1000 parcels per quote request.
Note that the required fields for an Order can vary depending on the type of order, the requested courier, whether it is local or international, etcetera. Shippit will then generate the order, allocate the courier, and fill in the origin location based on the provided info and merchant configuration on Shippit. Submits an Order to be created on Shippit.Īt minimum, an Order requires a delivery location, user details, and parcel details. Whilst this information in the request headers is currently optional, it is highly encouraged as it will allow Shippit to better support your integration by helping us to more easily identify which systems are making which API requests, and who to contact with pertinent information about specific integrations and/or platforms. This will help us to identify when all integrations on the same platform require action, or who to contact about known issues with a platform type. This could be a business name for self-maintained integrations, or the name of a technical partner maintaining the integration.Ī string identifying the platform/software making the calls.
#Shipit api software#
Useful information includes software library names, release versions/dates.Ī string to identify the entity developing and maintaining the integration. The headers are as follows: Request HeaderĪ string to help identify technical information about the integration. To assist Shippit’s support of our custom built API consumers we ask that requests to our HTTP APIs supply additional information in the request headers.
Should you need a higher rate, please contact our support. If you exceed this rate you'll receive a 429 HTTP error Rate LimitingĪll our APIs are rate limited to 60 requests per rolling 60 seconds per merchant (based on your API Key). You should see the token labelled as API Key.
To view your authentication token, login to your Shippit account, then visit Settings -> Integrations. This should be passed in the header containing Authorization: Bearer xxxx, subsituting the authentication token in the place of xxxx. To make requests to the API, an authentication token is required.
0 kommentar(er)
