You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
Home > Delivery Experience Management > Connecting your Shipment Data Source > Shipment Data Source Integrations > How do I connect my in-house order management system with my account?
How do I connect my in-house order management system with my account?
print icon

You can connect your API enabled in-house order processing system to push data to your account when you create a label for the shipment.


Add the following code to your server. Your account contains a unique API key to ensure the data you share with us is done securely. Enter your account's API key in the request along with the email address associated with your account.

    url = ""
    payload = "<< JSON Data >>"
    headers = {
        'X-Auth-Email': "[email protected]",
        'X-Auth-Key': "308473bc1fff0454ce6831ab3",
        'Content-Type': "application/json"

    response = requests.request("POST", url, data=payload, headers=headers)

At the event of Label Creation for every order, you would need to deliver a JSON payload in the body of a POST request.


Required Parameters

Parameter Description
API Key X digit API key generated by the user
Authorization Email Customer Authorization Email
Request Body JSON Data in required format


JSON Data Format

    "order_no":"<< Order No >>",
    "order_date":"<< Order Date >>", 
    "customer_name":"<< Customer Name >>",
    "customer_email":"<< Customer Email >>",
    "customer_phoneno":"<< Customer Phone Number >>",
    "trackingnumber":"<< Tracking Number >>",
    "carrier_type":"<< Carrier Type >>",
    "product":"<< product Name >>",
    "amount":"<< Amount >>",
    "number_of_items":"<< Number of Items >>",
    "shipping_address":"<< shipper address >>",
    "billing_address":"<< Billing address >>"

Sample Request:

    "order_date":"2019-07-25 19:08:49",
    "customer_name":"User Name",
    "customer_email":"[email protected]",
    "product":"Chin Cup For Softball Face Mask",
    "shipping_address":"Lacy Bailey,14 Lingo Rd,greenbrier,us 72058-8501",
    "billing_address":"Lacy Bailey,14 Lingo Rd,greenbrier,us 72058-8501"

Sample Response:

    "message":"Request Received Successfully",

HTTP Status codes

Result Status Message
Success Success(200 OK) Request Received Successfully
Order Details Not Found Failed(409 Conflict) Order Number,Trackingnumber,Carrier Type should not be empty
Invalid Data Format (JSON) Failed(409 Conflict) Invalid JSON format
Invalid API Key / Invalid Authorization Email Failed(401 Unauthorized) Authorization Header Error. Check Your Authorization Email and Authorization Key
Content-Type Error Failed(400 Bad Request) Authorization Header Error. Content-Type : application/json only accepted
API Key / Authorization Email Not Found Failed(400 Bad Request) Authorization Header Error. Authorization Email and Authorization Key Required
0 out of 0 found this helpful

scroll to top icon