Welcome to the API documentation for WeShip Logistics Solutions. We provide comprehensive API solutions to streamline and enhance your operation. Whether you're managing shipments, pickups, tracking, or accessing financial data, our APIs offer a seamless integration experience.
\nWeShip
\nWeShip Track
\nThis endpoint is used for user authentication, allowing users to log in by providing their email and password. It supports dynamic parameterization with variables {{email}}, {{password}}, and {{host}}. Upon successful authentication, the server responds with user-specific data.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Content-Type: Set to 'application/json' to indicate the format of the request payload.
Request Payload:
\nemail (string): The email address of the user.
password (string): The password associated with the user's account.
The \"Authentication\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the resources available:
\n","_postman_id":"4ed14133-fd7d-454b-a98a-a9b29b6fdb8e"},{"name":"Orders","item":[{"name":"Get Orders List","id":"9ee22a41-9491-42f9-b3a9-8950093d257d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Weship-API-Version","value":"1.0","type":"text"},{"key":"authorization","value":"{{token}}","type":"text"}],"url":"https://{{host}}/orders/find?limit=10&skip=0&fulfillment_status=all&financial_status=all","description":"This endpoint retrieves a list of orders based on specified criteria, allowing users to filter orders by fulfillment status, financial status, and apply pagination. It supports dynamic parameterization with the variable {{host}} and requires authentication with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Query Parameters:
\nlimit (number): The maximum number of items to retrieve. [Min 10, Max 100].
skip (number): The number of items to skip in the result set. [Min 10, Max 100].
fulfillment_status (string): Filter orders by fulfillment status ('all' or specific status).
financial_status (string): Filter orders by financial status ('all' or specific status).
This endpoint is used to create a new quote with detailed information about the sender, recipient, packages, and couriers preferences. It supports dynamic parameterization with the variables {{host}} for the API host, and {{token}} for the access token. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
Content-Type: Set to 'application/json' to indicate the format of the request payload.
Request Payload:
\nsender (object): Details of the sender, including:
name (string): The name of the sender [Max 30 characters].
email (string): The email address of the sender [Max 30 characters].
companyName (string): The company name of the sender [Min 3 and Max 30 characters].
phone (string): The phone number of the sender.
country (string): The country of the sender [Max 30 characters].
country_code (string): The country code of the sender. [2 characters].
province (string): The province or state of the sender [Max 30 characters].
province_code (string): The province code of the sender [2 characters].
city (string): The city of the sender [Max 30 characters].
address1 (string): The primary address line of the sender [Max 30 characters].
address2 (string): The secondary address line of the sender [Max 30 characters].
optionalInfo (string): Additional optional information about the sender [Max 30 characters].
zip (string): The postal code or ZIP code of the sender.
recipient (object): Details of the recipient, including:
name (string): The name of the recipient [Max 30 characters].
email (string): The email address of the recipient [Max 30 characters].
companyName (string or null): The company name of the recipient, or null if not applicable [Min 3 and Max 30 characters].
phone (string): The phone number of the recipient.
country (string): The country of the recipient [Max 30 characters].
country_code (string): The country code of the recipient [2 characters].
province (string): The province or state of the recipient [Max 30 characters].
province_code (string): The province code of the recipient [2 characters].
city (string): The city of the recipient [Max 30 characters].
address1 (string): The primary address line of the recipient [Max 30 characters].
address2 (string): The secondary address line of the recipient [Max 30 characters].
optionalInfo (string or null): Additional optional information about the recipient, or null if not applicable [Max 30 characters].
zip (string): The postal code or ZIP code of the recipient.
packages (array): An array of package objects, each specifying:
h (number): The height of the package.
w (number): The width of the package.
hh (number): The second height dimension of the package.
weight (number): The weight of the package.
sizeUnit (string): The unit of measurement for dimensions (e.g., \"CM\" / \"IN\").
weightUnit (string): The unit of measurement for weight (e.g., \"KG\" / \"LB\").
declaredValue (number): The declared value of the package.
courier (array): List of preferred courier services.
The \"Orders\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the resources available:
\n","_postman_id":"be0d9676-16ce-4999-957c-0ad5b8c4b682"},{"name":"Shipments","item":[{"name":"Get Shipments List","id":"c2ed2343-bb08-4e40-8b1e-a2201d3ee0e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Weship-API-Version","value":"1.0","type":"text"},{"key":"authorization","value":"{{token}}","type":"text"}],"url":"https://{{host}}/shipments/find?limit=10&skip=0","description":"This endpoint retrieves a list of shipments based on specified criteria, allowing users to apply pagination. It supports dynamic parameterization with the variables {{host}} for the API host and {{token}} for the access token, and requires authentication with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
Query Parameters:
\nlimit (optional): The maximum number of shipments to retrieve. [Min 10, Max 100].
skip (optional): The number of shipments to skip in the result set. [Min 10, Max 100].
This endpoint retrieves details for a specific shipment identified by the shipment_id. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token, and {{shipment_id}} for the unique identifier of the shipment. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
Path Parameters:
\nshipment_id (required): The unique identifier of the shipment for which details are to be retrieved.This endpoint is used to create a new shipment with detailed information about the sender, recipient, selected service, insurance, items, packages, and fulfillment preferences. It supports dynamic parameterization with the variables {{host}} for the API host, and {{token}} for the access token. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Content-Type: Set to 'application/json' to indicate the format of the request payload.Request Payload:
\nsender (object): Details of the sender, including:name (string): The name of the sender.email (string): The email address of the sender [Max 30 characters].companyName (string): The company name of the sender [Min 3 and Max 30 characters].phone (string): The phone number of the sender.country (string): The country of the sender.country_code (string): The country code of the sender. [2 characters].province (string): The province or state of the sender.province_code (string): The province code of the sender [2 characters].city (string): The city of the sender [Max 30 characters].address1 (string): The primary address line of the sender [Max 30 characters].address2 (string): The secondary address line of the sender [Max 30 characters].optionalInfo (string): Additional optional information about the sender [Max 30 characters].zip (string): The postal code or ZIP code of the sender.recipient (object): Details of the recipient, including:name (string): The name of the recipient.email (string): The email address of the recipient [Max 30 characters].companyName (string or null): The company name of the recipient, or null if not applicable [Min 3 and Max 30 characters].phone (string): The phone number of the recipient.country (string): The country of the recipient.country_code (string): The country code of the recipient [2 characters].province (string): The province or state of the recipient.province_code (string): The province code of the recipient [2 characters].city (string): The city of the recipient [Max 30 characters].address1 (string): The primary address line of the recipient [Max 30 characters].address2 (string): The secondary address line of the recipient [Max 30 characters].optionalInfo (string or null): Additional optional information about the recipient, or null if not applicable [Max 30 characters].zip (string): The postal code or ZIP code of the recipient.selectedService (object): Details of the selected service.serviceType (number): Type identifier for the selected service.serviceName (string): Name of the selected service.courier (string): Courier associated with the selected service.enabledInsurance (boolean): Indicates whether insurance is enabled for the shipment.items (array): Array of item objects.name (string): Name of the item.quantity (number): Quantity of the item.originCountry (object): Details of the origin country.name (string): Name of the origin country.code (string): Country code of the origin country.price_set (object): Details of the item price.shop_money (object): Details of the shop money.amount (string): Amount of money.currency_code (string): Currency code.packages (array): An array of package objects, each specifying:h (number): The height of the package.w (number): The width of the package.hh (number): The second height dimension of the package.weight (number): The weight of the package.sizeUnit (string): The unit of measurement for dimensions (e.g., \"CM\" / \"IN\").weightUnit (string): The unit of measurement for weight (e.g., \"KG\" / \"LB\").declaredValue (number): The declared value of the package.fulfillment (boolean): Indicates whether fulfillment is enabled for the shipment.currency_code (string): Currency code for the shipment [\"MXN\"].total_amount_insurance (number): Total amount of insurance for the shipment.This endpoint is used to cancel a shipment by providing details such as the shipment id, courier, and trackingNumber. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token, and variables like {{id}}, {{courier}}, and {{trackingNumber}} for specific shipment details. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Content-Type: Set to 'application/json' to indicate the format of the request payload.Request Payload:
\nid (number): The unique identifier of the shipment to be canceled.
courier (string): The courier associated with the shipment.
trackingNumber (string): The tracking number of the shipment.
This endpoint is used to retrieve labels for a shipment by providing the trackingNumber, courier, and format. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token, and variables like {{trackingNumber}}, {{courier}}, and {{format}} for specific label details. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Content-Type: Set to 'application/json' to indicate the format of the request payload.Request Payload:
\ntrackingNumber (string): The tracking number of the shipment for which labels are to be retrieved.courier (string): The courier associated with the shipment.format (string): The desired format for the labels.This endpoint is used to retrieve tracking information for a shipment by providing the id, courier, and trackingNumber. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token, and variables like {{id}}, {{courier}}, and {{trackingNumber}} for specific tracking details. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Content-Type: Set to 'application/json' to indicate the format of the request payload.Request Payload:
\nid (number): The unique identifier of the shipment for tracking.
courier (string): The courier associated with the shipment.
trackingNumber (string): The tracking number of the shipment.
The \"Shipments\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the resources available:
\n","_postman_id":"0f1c3d91-5215-494f-91ef-bb5432492657"},{"name":"Pickups","item":[{"name":"Get Pickups List","id":"519a111e-1a96-4730-9f02-fc912dd821ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Weship-API-Version","value":"1.0","type":"text"},{"key":"authorization","value":"{{token}}","type":"text"}],"url":"https://{{host}}/pickups/find?limit=10&skip=0","description":"This endpoint is used to retrieve a list of pickups with optional parameters for pagination, such as limit and skip. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token, and query parameters like limit and skip for controlling the number of pickups returned. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
Query Parameters:
\nlimit (optional, number): The maximum number of pickups to retrieve. Default is 10.
skip (optional, number): The number of pickups to skip. Default is 0.
This endpoint is used to request a pickup for a set of shipments. It requires detailed information about the pickup, including shipment IDs, quantity, total weight, weight unit, courier, pickup time, pickup date, items, location, main package details, main customer information, and pickup timestamps. It supports dynamic parameterization with the variables {{host}} for the API host, {{token}} for the access token. Authentication is required with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.Request Payload:
\nshipments: An array containing the IDs of the shipments to be picked up.quantity: The total number of shipments to be picked up.totalWeight: The total weight of all shipments combined.weightUnit: The unit of weight (e.g., KG / LB).courier: The designated courier for the pickup.netWeight: The net weight of the shipments.time: The time range during which the pickup is scheduled.date: The scheduled date and time of the pickup.pickupDate: The specific date for the pickup.items: Description of the items to be picked up.location (object): Details of the pickup location, including:name (string): The name of the pickup location.email (string): The email address of the pickup location [Max 30 characters].companyName (string): The company name of the pickup location [Min 3 and Max 30 characters].phone (string): The phone number of the pickup location.country (string): The country of the pickup location.country_code (string): The country code of the pickup location [2 characters].province (string): The province or state of the pickup location.province_code (string): The province code of the pickup location [2 characters].city (string): The city of the pickup location [Max 30 characters].address1 (string): The primary address line of the pickup location [Max 30 characters].address2 (string): The secondary address line of the pickup location [Max 30 characters].optionalInfo (string): Additional optional information about the pickup location [Max 30 characters].zip (string): The postal code or ZIP code of the pickup location.pickupResponsible: The name of the pickup location responsible.mainPackage (object): Information about the main package being picked up, including:h (number): The height of the package.w (number): The width of the package.hh (number): The second height dimension of the package.weight (number): The weight of the package.sizeUnit (string): The unit of measurement for dimensions (e.g., \"CM\" / \"IN\").weightUnit (string): The unit of measurement for weight (e.g., \"KG\" / \"LB\").declaredValue (number): The declared value of the package.volumetricWeight: The volumetric weight of the package.mainCustomerInfo (object): Information about the main customer and their address.trackingNumber (string): The tracking number.customerAddress (object): Details of the main customer address, including.name (string): The name of the customer.email (string): The email address of the customer[Max 30 characters].companyName (string): The company name of the customer [Min 3 and Max 30 characters].phone (string): The phone number of the customer.country (string): The country of the customer.country_code (string): The country code of the customer [2 characters].province (string): The province or state of the customer.province_code (string): The province code of the customer [2 characters].city (string): The city of the customer [Max 30 characters].address1 (string): The primary address line of the customer [Max 30 characters].address2 (string): The secondary address line of the customer [Max 30 characters].optionalInfo (string): Additional optional information about the customer [Max 30 characters].zip (string): The postal code or ZIP code of the customer.readyDateTimestamp: Timestamp indicating when the shipments will be ready for pickup.closeDateTimestamp: Timestamp indicating the closing time for the pickup.The \"Pickups\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the resources available:
\n","_postman_id":"9d026d53-aa0f-4511-8c22-c5dad987d8a9"},{"name":"Transactions","item":[{"name":"Get Transactions List","id":"ec7cdafb-9f02-4b43-9edf-bbb62728894c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Weship-API-Version","value":"1.0","type":"text"},{"key":"authorization","value":"{{token}}","type":"text"}],"url":"https://{{host}}/transaction/invoices?limit=10&skip=0&type=all&startDate=2023-11-29T15:37:52-06:00&endDate=2023-12-29T15:37:52-06:00","description":"This endpoint retrieves a list of transactions based on specified criteria, allowing users to apply pagination. It supports dynamic parameterization with the variables {{host}} for the API host and {{token}} for the access token, and requires authentication with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
Query Parameters:
\nlimit: The number of invoices to retrieve (default: 10).
skip: Number of invoices to skip (default: 0).
type: Filter by invoice type (e.g., all, paid, unpaid).
startDate: Start date for filtering invoices (format: YYYY-MM-DDTHH:mm:ssZ).
endDate: End date for filtering invoices (format: YYYY-MM-DDTHH:mm:ssZ).
This endpoint retrieves an information about the current balance. It supports dynamic parameterization with the variables {{host}} for the API host and {{token}} for the access token, and requires authentication with a valid access token passed in the Authorization header.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid access token in the Authorization header.
The \"Transaction\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the resources available:
\n","_postman_id":"b1876ead-6c5b-4891-8c62-38197c0fac45"}],"id":"748a9e29-a947-4ada-bb14-61fe077e1330","description":"WeShip API is a leading logistics platform that empowers businesses with efficient quote, shipping, tracking, and pickup services. Our commitment is to simplify the complexities of logistics, providing a reliable and comprehensive solution for your shipping needs.
\nSandbox Host: apisandbox.weship.com
Production Host: api.weship.com
This endpoint is used for user authentication, allowing users to log in by providing their email and password. Upon successful authentication, the server responds with a JSON Web Token (JWT) that can be used to authorize and access protected resources.
\nRequest Headers:
\nContent-Type: Set to 'application/json' to indicate the format of the request payload.Request Payload:
\nemail (string): The email address of the user.password (string): The password associated with the user's account.Response 200
\nUpon successful authentication, the server will respond with a status code of 200 and a JSON object containing:
\nsuccess (boolean): Indicates whether the authentication was successful.accessToken (string): The access token that can be used for subsequent authorized requests.{\n \"success\": true,\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TRkYjE2ZlMTMiLCJ2\"\n}\n\nThe \"Authentication\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the available resources:
\n","_postman_id":"e942a629-74e2-4418-9221-a662bd1ac656"},{"name":"Shipments","item":[{"name":"Get Shipments List","id":"da6141a0-221d-4d91-8f57-95e471577e27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Weship-API-Version","value":"1.0","type":"text"}],"url":"https://{{host}}/api/v1/shipment/list?where={\"fulfillmentDate\": {\"[gte]\": \"2023-12-12T06:00:00.000Z\",\"[lte]\": \"2024-01-12T05:59:59.999Z\"},\"status\": \"Label created\",\"markedAs\": \"OPEN\"}&limit=10&offset=0&sortBy=fulfillmentDate&sortDir=ASC","description":"This endpoint retrieves a list of shipments based on specified criteria, offering the flexibility to filter, paginate, and sort the results. Users can retrieve shipments that fall within a specified fulfillment date range, have a specific status, and are marked with a particular status.
\nRequest Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Authorization: Bearer token for authentication. Include a valid JWT (JSON Web Token) in the Authorization header.
Query Parameters:
\nwhere (optional): A JSON-encoded string specifying the conditions for filtering shipments. In the provided example, shipments are filtered by fulfillment date, status (\"Label created\"), and marked status (\"OPEN\").limit (optional): The maximum number of items to retrieve. Default is 10.offset (optional): The number of items to skip in the result set. Default is 0.sortBy (optional): The field by which the results should be sorted. Default is \"fulfillmentDate\".sortDir (optional): The sorting direction, either \"ASC\" (ascending) or \"DESC\" (descending). Default is \"ASC\".This endpoint allows users to create a new shipment by providing details such as the tracking number, carrier information, origin and destination details, customer information, and order details. The created shipment will be associated with the provided tracking number and carrier.
\nRequest Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Content-Type: Set to 'application/json' to indicate the format of the request payload.
Authorization: Bearer token for authentication. Include a valid JWT (JSON Web Token) in the Authorization header.
Request Payload:
\ntrackingNumber (string): The tracking number associated with the shipment.carrierId (string): The unique identifier of the carrier. [Couriers List]carrierName (string): The name of the carrier.originCountryCode (string): The country code of the origin location.originCountry (string): The name of the origin country.originProvinceCode (string): The province code of the origin location.originProvince (string): The name of the origin province.destinationCountryCode (string): The country code of the destination location.destinationCountry (string): The name of the destination country.destinationProvinceCode (string): The province code of the destination location.destinationProvince (string): The name of the destination province.orderNumber (string): The order number associated with the shipment.name (string): The name of the customer.email (string): The email address of the customer.phoneNumber (string): The phone number of the customer.This endpoint retrieves the tracking status of one or more shipments based on the provided courier and tracking information. Users can submit a list of shipments with details such as the courier name and tracking number to get real-time status updates.
\nRequest Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Content-Type: Set to 'application/json' to indicate the format of the request payload.
Authorization: Bearer token for authentication. Include a valid JWT (JSON Web Token) in the Authorization header.
Request Payload:
\nshipments: An array of shipment objects, where each object includes:courier (string): The name of the courier for the shipment.tracking (string): The tracking number associated with the shipment.This endpoint is used to update the carrier associated with a specific shipment identified by its unique identifier (shipmentId). Users can set or change the carrier for a particular shipment by providing the new carrier's unique identifier (courierId) in the request payload.
Request Headers:
\nWeship-API-Version: Version identifier for the Weship API. Set to '1.0'.
Content-Type: Set to 'application/json' to indicate the format of the request payload.
Authorization: Bearer token for authentication. Include a valid JWT (JSON Web Token) in the Authorization header.
Request Path Parameter:
\nshipmentId (string): The unique identifier of the shipment for which the carrier is being updated.Request Payload:
\ncourierId (string): The unique identifier of the new carrier to be associated with the shipment.The \"Shipments\" collection focuses on operations related to authorization within the API. Below is an overview of the collection and the available resources:
\n","_postman_id":"e6bb1ee7-0827-46c9-8626-91d372598095"}],"id":"9ae1fde4-c294-4824-b153-aa21ed026acb","description":"The WeShip Tract API is a robust and versatile solution designed to facilitate the tracking of shipments across a vast network of more than 1200 carriers worldwide. This API provides developers with the tools to seamlessly integrate tracking functionalities into their applications, enabling users to access real-time and accurate information about the status and location of their shipments.
\n","_postman_id":"9ae1fde4-c294-4824-b153-aa21ed026acb"}]}