WeShipItNow Logo
API docs by Redocly

WeShipItNow Shipping API (1.0.0)

Download OpenAPI specification:Download

Aurore Holdings: techservice@weshipitnow.com URL: weshipitnow.com License: Terms of Service

Overview

The WeShipItNow Shipping API is an advanced platform specifically designed to enhance the shipping and logistics capabilities of e-commerce businesses and logistics providers. This API offers a comprehensive suite of features aimed at automating and optimizing shipping processes, thereby improving efficiency and customer satisfaction.

Core Features

  • Real-Time Rate Calculation: Instantly obtain shipping rates based on package dimensions, weight, and destination. This allows businesses to provide accurate shipping costs to customers at checkout.
  • Label Generation: Automate the creation and purchase of shipping labels directly through the API. This feature reduces the time and effort required to prepare shipments, ensuring a smooth dispatch process.
  • Account Management: Access detailed account information including balances, transaction history, and user profiles. This helps businesses keep track of their shipping expenses and operational metrics.
  • Order Retrieval: Seamlessly pull order data from popular e-commerce platforms. This feature simplifies order management by consolidating orders from multiple sources into a single system.
  • Secure Access: Implement robust authentication and authorization protocols to protect sensitive data and ensure that only authorized users can access the API.
  • Comprehensive Error Reporting: Benefit from detailed error messages and standardized response codes that facilitate troubleshooting and enhance the reliability of the API.

Advantages

  • Operational Efficiency: Streamline shipping operations by automating key processes, reducing manual workload, and minimizing errors.
  • Cost Savings: Utilize real-time rate calculations to choose the most economical shipping options, thereby lowering shipping costs.
  • Improved Customer Experience: Faster order processing and accurate shipping information lead to timely deliveries, boosting customer satisfaction.
  • Seamless Integration: The API is designed to integrate effortlessly with existing systems, ensuring a smooth implementation process without disrupting current operations.

Ideal For

  • E-commerce Businesses: Enhance shipping capabilities, streamline operations, and provide a better customer experience.
  • Logistics Providers: Offer clients advanced shipping solutions that improve efficiency and service quality.
  • Retailers: Simplify the shipping process for both online and in-store orders, ensuring prompt delivery.
  • Marketplaces: Centralize order and shipping management to improve logistical control and efficiency. The WeShipItNow Shipping API is your go-to solution for simplifying and optimizing shipping and logistics operations. With features designed to automate key processes and improve overall efficiency, this API helps businesses focus on growth and delivering exceptional customer experiences. Whether you need to calculate shipping rates, generate labels, or manage orders, the WeShipItNow Shipping API is the comprehensive tool you need to succeed in today’s competitive market.

API Sandbox

Shipping Sandbox Controller

Sandbox Purchase Label

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Request Body schema: application/json
required

request

object (Address)
marketplaceOrderId
string

Provide marketplace order Id if possible, length < 255

packingSlip
boolean

Choose if you want packing slip along with the label, boolean default yes, not required

required
Array of objects (Parcel)

A list of parcels to be shipped, scale unit: INCH. We only take one parcel for each AMAZON_GROUND shipment now.

serviceType
string

Service Type. Specify a service type. Default AMAZON_GROUND if not specified. Example: Enum: "usps_first_class_mail" "usps_ground_advantage" "usps_priority_mail" "usps_priority_mail_express" "usps_parcel_select" "usps_media_mail" "usps_first_class_mail_international" "usps_priority_mail_international" "usps_priority_mail_express_international" "usps_pay_on_use_return" "ups_next_day_air_early" "ups_next_day_air" "ups_next_day_air_saver" "ups_2nd_day_air_am" "ups_2nd_day_air" "ups_3_day_select" "ups_ground" "ups_standard" "ups_ground_am" "ups_ground_pm" "fedex_first_overnight" "fedex_priority_overnight" "fedex_standard_overnight" "fedex_2day_am" "fedex_2day" "fedex_express_saver" "fedex_ground" "fedex_home_delivery" "fedex_ground_home_delivery_pm" "fedex_ground_am" "fedex_ground_an" "fedex_ground_pm" "amazon_ground"

object (SpecialServiceOption)
required
object (Address)
userId
required
string

Your API token

Responses

Request samples

Content type
application/json
{
  • "fromAddress": {
    },
  • "marketplaceOrderId": "string",
  • "packingSlip": true,
  • "parcelList": [
    ],
  • "serviceType": "string",
  • "specialServiceOption": {
    },
  • "toAddress": {
    },
  • "userId": "string"
}

Account Info API

Ex Account Controller

Get Account Info

header Parameters
Authorization
required
string

Authorization

Responses

Get Account Shipping Profile

header Parameters
Authorization
required
string

Authorization

Responses

Address Service API

Ex Address Controller

Validate Address

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Request Body schema: application/json
required

request

required
object (Address)

Responses

Request samples

Content type
application/json
{
  • "address": {
    }
}

Report API

Ex Report Controller

Send Report

header Parameters
Authorization
required
string

Authorization

Request Body schema: application/json
required

report

affectedUsers
integer <int32>

Number of affected users

assignedTo
string

Team member assigned to the report

attachments
string <byte>

Screenshots or attachments that provide visual evidence of the problem

clientInfo
string

Information about the user's browser or client

deviceInfo
string

Information about the user's device

environment
required
string

The user's operating system or environment

environmentVariables
string

Environment variables or configuration settings

feature
string

Relevance to a specific feature or area of the application

location
string

URL or location where the error occurred

logs
string

Logs or error messages generated by the application

networkConnection
string

Network connection type (e.g., Wi-Fi, cellular)

reportType
required
string

The type of the report (e.g., bug report, feedback, feature request)

reproducibility
string

Reproducibility of the issue and frequency

resolution
string

Resolution or workaround for the issue

severity
required
string

The severity or priority level of the issue (e.g., low, medium, high, critical)

status
string

Status of the report (e.g., open, in progress, resolved)

stepsToReproduce
required
string

Detailed steps to reproduce the issue

timestamp
string

Timestamp of when the report was created

title
required
string

A brief title or subject line summarizing the issue

userFeedback
string

General user feedback or suggestions

userId
string

User ID associated with the report

Responses

Request samples

Content type
application/json
{
  • "affectedUsers": 0,
  • "assignedTo": "string",
  • "attachments": "string",
  • "clientInfo": "string",
  • "deviceInfo": "string",
  • "environment": "string",
  • "environmentVariables": "string",
  • "feature": "string",
  • "location": "string",
  • "logs": "string",
  • "networkConnection": "string",
  • "reportType": "string",
  • "reproducibility": "string",
  • "resolution": "string",
  • "severity": "string",
  • "status": "string",
  • "stepsToReproduce": "string",
  • "timestamp": "string",
  • "title": "string",
  • "userFeedback": "string",
  • "userId": "string"
}

Shipping API

External Endpoint Controller

Cancel Shipment

query Parameters
OrderId
required
string

OrderId

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Responses

Download Label

query Parameters
LabelFileId
required
string

LabelFileId

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Responses

Generate Scan Form

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Request Body schema: application/json
required

scanFormRequest

ignoreUnidentifiedTracking
boolean

Specify whether to bypass tracking number check, default false

imageType
string

Specify a image type. Default PDF if not specified. Example: Enum: "PDF" "TIFF" "JPG" "SVG" "NONE"

labelType
string

Specify a label type. Default 8.5x11LABEL if not specified. Example: Enum: "8.5x11LABEL"

trackingNumbers
required
Array of strings

A list of tracking number that need to be generated. Max size 500.

Responses

Request samples

Content type
application/json
{
  • "ignoreUnidentifiedTracking": true,
  • "imageType": "string",
  • "labelType": "string",
  • "trackingNumbers": [
    ]
}

Get Label Rates

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Request Body schema: application/json
required

request

object (Address)
required
Array of objects (Parcel)

A list of parcels to be shipped, scale unit: INCH. We only take one parcel for each AMAZON_GROUND shipment now.

serviceType
string

Service Type. Specify a service type. Default AMAZON_GROUND if not specified. Example: Enum: "usps_first_class_mail" "usps_ground_advantage" "usps_priority_mail" "usps_priority_mail_express" "usps_parcel_select" "usps_media_mail" "usps_first_class_mail_international" "usps_priority_mail_international" "usps_priority_mail_express_international" "usps_pay_on_use_return" "ups" "ups_2nd_day_air" "ups_ground" "ups_3_day_select" "ups_next_day_air_saver" "ups_2nd_day_air_am" "ups_heavy_goods" "fedex" "fedex_ground" "fedex_first_overnight" "fedex_home_delivery" "fedex_ground_economy" "fedex_priority_overnight" "fedex_standard_overnight" "fedex_2day" "fedex_2day_am" "fedex_express_saver" "fedex_sameday" "fedex_sameday_city" "amazon_ground"

object (SpecialServiceOption)
required
object (Address)
userId
required
string

Your API token

Responses

Request samples

Content type
application/json
{
  • "fromAddress": {
    },
  • "parcelList": [
    ],
  • "serviceType": "string",
  • "specialServiceOption": {
    },
  • "toAddress": {
    },
  • "userId": "string"
}

Purchase Label

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Request Body schema: application/json
required

request

object (Address)
marketplaceOrderId
string

Provide marketplace order Id if possible, length < 255

packingSlip
boolean

Choose if you want packing slip along with the label, boolean default yes, not required

required
Array of objects (Parcel)

A list of parcels to be shipped, scale unit: INCH. We only take one parcel for each AMAZON_GROUND shipment now.

serviceType
string

Service Type. Specify a service type. Default AMAZON_GROUND if not specified. Example: Enum: "usps_first_class_mail" "usps_ground_advantage" "usps_priority_mail" "usps_priority_mail_express" "usps_parcel_select" "usps_media_mail" "usps_first_class_mail_international" "usps_priority_mail_international" "usps_priority_mail_express_international" "usps_pay_on_use_return" "ups_next_day_air_early" "ups_next_day_air" "ups_next_day_air_saver" "ups_2nd_day_air_am" "ups_2nd_day_air" "ups_3_day_select" "ups_ground" "ups_standard" "ups_ground_am" "ups_ground_pm" "fedex_first_overnight" "fedex_priority_overnight" "fedex_standard_overnight" "fedex_2day_am" "fedex_2day" "fedex_express_saver" "fedex_ground" "fedex_home_delivery" "fedex_ground_home_delivery_pm" "fedex_ground_am" "fedex_ground_an" "fedex_ground_pm" "amazon_ground"

object (SpecialServiceOption)
required
object (Address)
userId
required
string

Your API token

Responses

Request samples

Content type
application/json
{
  • "fromAddress": {
    },
  • "marketplaceOrderId": "string",
  • "packingSlip": true,
  • "parcelList": [
    ],
  • "serviceType": "string",
  • "specialServiceOption": {
    },
  • "toAddress": {
    },
  • "userId": "string"
}

Track Shipment

query Parameters
TrackingNumber
required
string

TrackingNumber

header Parameters
Authorization
required
string
Default: Bearer <Your-Token>
Example: Bearer <Your-Token>

Authorization header with a valid access token (e.g., 'Bearer ')

Responses

Statistics API

Ex Statistics Controller

Get Statistics

header Parameters
Authorization
required
string

Authorization

Responses