This collection provides all the details you need to integrate with the SpeeDee ShipIt platform for managing shipments—from creating and updating shipments to tracking and cancellation. The API is fully RESTful and uses JSON for request and response bodies.
\n\n\nNOTE: This collection has collection variables used for basic authentication. Update the username and password values with your test environment credentials to test directly from Postman.
\n
The label template ID is passed to define what type of label will be returned. These are the currently published public label types that are supported. Please note that not every format is supported by a label template.
\nFormat types:
0 = ZPL
1 = PDF
For custom label requests please reach out to integrations@speedeedelivery.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32232343","collectionId":"4eca1403-daa1-4bae-893d-87d07f83cb44","publishedId":"2sAYk7S4Ba","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ff4734"},"publishDate":"2025-03-18T18:02:21.000Z"},"item":[{"name":"Orders","item":[{"name":"Create a new order","id":"e0425b8c-155b-40fd-afe0-55d7ec8e4b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{ \n \"dropoffAddress\": { //Required\n \"addressLine1\": \"Use this endpoint to create a new shipment in SpeeDee’s system. This is typically the first step in scheduling a delivery. A successful creation returns the new order’s details.
\nThe request must be a JSON object containing the following parameters:
\ndropoffAddress: Object containing the dropoff address details.
\naddressLine1: (string) The primary address line.
city: (string) The city of the dropoff location.
postalCode: (string) The postal code of the dropoff location.
stateProvince: (string) The state or province of the dropoff location.
addressLine2: (string) Additional address line (optional).
company: (string) Company name (optional).
pickupAddress: Object containing the pickup address details (same structure as dropoffAddress).
\npickupLocation: Object containing the pickup location coordinates.
\nlatitude: (double) Latitude of the pickup location.
longitude: (double) Longitude of the pickup location.
pickupContactInfo: Object containing the contact information for pickup.
\nid: (integer) Unique identifier for the contact.
name: (string) Name of the contact.
phoneNumber: (string) Contact phone number.
email: (string) Contact email address.
language: (string) Preferred language for communication.
pickupWindow: Object defining the pickup time window.
\nstart: (dateTime) Start time of the pickup window.
end: (dateTime) End time of the pickup window.
pickupLocalWindow: Object defining the local pickup time window (same structure as pickupWindow).
\npickupNotes: (string) Additional notes for pickup.
\ndropoffLocation: Object containing the dropoff location coordinates (same structure as pickupLocation).
\ndropoffContactInfo: Object containing the contact information for dropoff (same structure as pickupContactInfo).
\ndropoffWindow: Object defining the dropoff time window (same structure as pickupWindow).
\ndropoffLocalWindow: Object defining the local dropoff time window (same structure as pickupWindow).
\ndropoffNotes: (string) Additional notes for dropoff.
\nnotes: (string) General notes for the order.
\nserviceLevelId: (string) Identifier for the service level.
\nwebhookUrl: (string) Optional URL for receiving delivery status callbacks.
\nmetadata: Object containing additional metadata.
\noccaecatf: (string)
enim4: (string)
eu_ca: (string)
numberOfPieces: (integer) Total number of pieces in the shipment.
\nweight: (double) Total weight of the shipment.
\nreadyAt: (dateTime) Time when the shipment is ready.
\npickupLocalReadyAt: (dateTime) Local time when the shipment is ready for pickup.
\nvehicleTypeId: (string) Identifier for the vehicle type.
\nattributeIds: (array of strings) List of attribute identifiers.
\nextraFees: Array of objects representing any extra fees.
\nextraFeeId: (string) Identifier for the extra fee.
quantity: (double) Quantity of the extra fee.
pickupDurationInMinutes: (integer) Duration of the pickup in minutes.
\ndeliveryDurationInMinutes: (integer) Duration of the delivery in minutes.
\ncollectOnDelivery: (double) Amount to be collected on delivery.
\ncollectOnPickup: (double) Amount to be collected on pickup.
\nallowPartialCollectOnDelivery: (boolean) Whether partial collection on delivery is allowed.
\nallowPartialCollectOnPickup: (boolean) Whether partial collection on pickup is allowed.
\nrequireIdentityValidation: (boolean) Whether identity validation is required.
\nrequireIdentityValidationOnPickup: (boolean) Whether identity validation is required on pickup.
\ngenerateProofOfDeliveryOnDelivery: (boolean) Whether to generate proof of delivery on delivery.
\nreferenceNumber1: (string) First reference number.
\nreferenceNumber2: (string) Second reference number.
\nreferenceNumber3: (string) Third reference number.
\nworkflows: Array of workflow objects.
\nid: (string) Identifier for the workflow.
workflowType: (integer) Type of workflow.
workflowSteps: Array of steps in the workflow.
stepId: (string) Identifier for the step.
selectionStepId: (string) Identifier for the selection step.
isActive: (boolean) Whether the step is active.
userFields: Array of user-defined fields.
\nuserFieldId: (string) Identifier for the user field.
value: (string) Value of the user field.
items: Array of item objects.
\nbarcodeTemplate: (string) Template for the barcode.
parcelTypeId: (string) Identifier for the parcel type.
description: (string) Description of the item.
weight: (double) Weight of the item.
height: (double) Height of the item.
length: (double) Length of the item.
width: (double) Width of the item.
userFields: Array of user-defined fields (same structure as userFields).
On success, the response will return a JSON object containing:
\nIn case of input validation issues (e.g., missing required address fields), the response will still be 200 OK but will include a validationErrors array highlighting the problems that should be fixed.
Always include Basic Auth credentials in the request.
\nOptionally, you can provide a webhookUrl in the request body. If provided, SpeeDee will send a POST callback to that URL containing the order ID when the shipment is delivered or canceled, enabling your system to react to delivery status changes automatically.
Create a return order in the system. Even though an order is created successfully, the response can return an array named \"validationErrors\" containing errors that will neStartFragmentUse this endpoint to generate a return shipment (a shipment going back from the original recipient to the original sender, or to another designated return address) using a previously created order as the source. It is commonly used for return labels or return pickups. You must provide the original order’s ID that this return is based on. The API will link the two orders (original and return) for tracking purposes. The response will contain the new return order’s details, and similarly to creating a new order, may include a validationErrors array if some details need correction. Basic Auth is required.
(Required)
\n","type":"text/plain"},"key":"sourceOrderId","value":"SDXXXXX"}],"variable":[]}},"response":[],"_postman_id":"ad0982c9-0f46-4f4a-9907-0e48fa3886b6"},{"name":"Create a new order from a template","id":"2ec74c17-1182-4da8-9a2d-faa3d41299b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"text/plain"}],"url":"{{baseUrl}}/api/v1/orders/from-template?orderTemplateId=Use this endpoint to streamline order creation by using a pre-configured order template. An order template typically contains preset details (addresses, service level, perhaps items) that you frequently use. By providing the template’s ID, the API will generate a new order populated with those template details, which you can then override or supplement via the request if needed. This is useful for recurring shipment patterns or for quickly reordering. As with standard order creation, any validation issues will be returned in a validationErrors array in the response. Basic authentication is required. If a webhookUrl is part of the template or provided in the request, the system will send an HTTP POST to that URL with the new order’s ID when key events (like delivered or canceled) happen, just as with regular order creation.
Use this endpoint to get a price quote and other details (like estimated delivery time) for a shipment without creating the shipment. It’s useful when you want to show shipping options or costs to a user before booking, or to decide which service level to use. Provide the shipment information in the request just as you would for order creation (pickup/dropoff addresses, weight, etc.), and the API will respond with an estimate. The response will include pricing information and a breakdown of charges. If certain inputs are invalid or missing, you’ll get a validationErrors list – you should correct these before trying to actually create an order with the same data. This endpoint also requires Basic Auth.