Input data

Output data

Incorrect login or API key

{
    "error": {
        "code": "access_denied",
        "message": [
            "Access denied"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>access_denied</code>
    <message>Access denied</message>
</error>
                                

Input data

Order info (* required)

Address info

Order custom fields

Item info (* required)

Item custom fields

You can provide an order data in 2 formats: JSON, XML

JSON

{
    "order":
    {
        "order_reference":"1000000000000",
        "order_date":"10/20/2015",
        "rma": "12345",
        "contact_name":"John Smith",
        "company_name":"",
        "addr1":"6 Semaphore Close Mount Pleasant",
        "addr2":"",
        "addr3":"",
        "city":"Christchurch",
        "zip":"8081",
        "state":"qwe",
        "country":"NZ",
        "phone":"+102030405060",
        "email":"john.smith@googlemail.com",
        "currency_code":"AUD",
        "cost_price_currency":"USD",
        "export_awb":"32153454GB",
        "export_carrier_name":"USPS",
        "free_return":true,
        "custom_fields": {
            "field1": "Some additional description for this order"
        },
        "item":[
            {
                "sku_code":"QWE123",
                "sku_desc":"Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity":"5",
                "price":"100",
                "cost_price": "13.12",
                "cost_price_currency":"EUR",
                "weight":"1",
                "length":"2",
                "width":"3",
                "height":"4",
                "dimensions_uom":"mm",
                "hs_code":"999999",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "tracking": "123456789",
                "non_returnable": "true",
                "non_returnable_message": "Body shapers are non returnable",
                "days_for_return": 0,
                "custom_fields": {
                    "field1": "Some additional description for this item"
                }
            },
            {
                "sku_code":"QWE456",
                "sku_desc":"Black Halterneck Corset",
                "quantity":"10",
                "price":"200",
                "cost_price": "25.12",
                "weight":"0.86",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"999999",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "tracking": "123456780",
                "days_for_return": 120
            }
        ]
    }
}

XML

<order>
    <order_reference>1000000000000</order_reference>
    <order_date>10/20/2015</order_date>
    <rma>12345</rma>
    <contact_name>John Doe</contact_name>
    <company_name></company_name>
    <addr1>6 Semaphore Close Mount Pleasant</addr1>
    <addr2></addr2>
    <addr3></addr3>
    <city>Christchurch</city>
    <zip>8081</zip>
    <state>qwe</state>
    <country>NZ</country>
    <phone>+102030405060</phone>
    <email>john.smith@googlemail.com</email>
    <currency_code>AUD</currency_code>
    <export_awb>32153454GB</export_awb>
    <export_carrier_name>USPS</export_carrier_name>
    <free_return>true</free_return>
    <custom_fields>
        <field1>Some additional description for this order</field1>
    </custom_fields>
    <item>
        <sku_code>QWE123</sku_code>
        <sku_desc>Black Sculpting &amp; Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>5</quantity>
        <price>100</price>
        <cost_price>13.12</cost_price>
        <weight>0.3</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <country_code>CN</country_code>
        <hs_code>999999</hs_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>Yes</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <tracking>123456789</tracking>
        <non_returnable>true</non_returnable>
        <days_for_return>0</days_for_return>
        <custom_fields>
            <field1>Some additional description for this order</field1>
        </custom_fields>
    </item>
    <item>
        <sku_code>QWE456</sku_code>
        <sku_desc>Black Halterneck Corset</sku_desc>
        <quantity>10</quantity>
        <price>200</price>
        <cost_price>25.12</cost_price>
        <weight>0.86</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>999999</hs_code>
        <country_code>GB</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>Yes</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <tracking>123456780</tracking>
        <days_for_return>120</days_for_return>
    </item>
</order>

Output data

Order created successfully:

{
    "success": {
        "message": "Order successfully created",
        "order_reference": "1000000000000",
        "order_id": 10000
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <message>Order successfully created</message>
    <order_reference>12312355</order_reference>
    <order_id>10000000</order_id>
</success>

Incorrect order data:

{
    "error": {
        "code": "order_incorrect",
        "message": [
            "Incorrect order data. Check fields: quantity,price"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>order_incorrect</code>
    <message>Incorrect order data. Check fields: quantity,price</message>
</error>

Order reference is already exists:

{
    "error": {
        "code": "order_exists",
        "message": [
            "Order reference is already exists"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>order_exists</code>
    <message>Order reference is already exists</message>
</error>

JSON is not valid:

{
    "error": {
        "code": "json_invalid",
        "message": [
            "JSON is not valid"
        ]
    }
}
        

XML is not valid:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>xml_invalid</code>
    <message>XML is not valid</message>
</error>

Input data

Order info

You can provide an order data in 2 formats: JSON, XML

JSON

{
    "order":
    {
        "type":"reference",
        "val":"600090343"
    }
}

XML

<order>
    <type>reference</type>
    <val>600090343</val>
</order>

Output data

Data found:

JSON response example:

{
    "success": {
        "id": "3103",
        "order_reference": "12312359",
        "order_date": "1432958400",
        "contact_name": "John Doe",
        "company_name": "",
        "addr1": "address line",
        "addr2": "",
        "addr3": "",
        "city": "some address",
        "zip": "20000",
        "state": "NY",
        "country": "GB",
        "phone": "+010557779",
        "email": "doe@gmail.com",
        "currency_code": "EUR",
        "cost_price_currency": "USD",
        "rma": "",
        "export_awb": "444444US",
        "export_carrier_name": "USPS",
        "free_return": true,
        "item": [
            {
                "sku_code": "ASD111",
                "sku_desc": "Black Sculpting  Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity": "5",
                "price": "100",
                "cost_price": "53.12",
                "cost_price_currency": "USD",
                "weight": "0.3",
                "weight_uom": "",
                "length": "0",
                "width": "0",
                "height": "0",
                "dimensions_uom": "mm",
                "hs_code": "5905954",
                "country_code": "CN",
                "img_path": "",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "non_returnable_message": "Some message"
            },
            {
                "sku_code": "UN-12322;28",
                "sku_desc": "Black Halterneck  Corset",
                "quantity": "10",
                "price": "200",
                "cost_price": "120.13",
                "cost_price_currency": "USD",
                "weight": "0.86",
                "weight_uom": "",
                "length": "0",
                "width": "0",
                "height": "0",
                "dimensions_uom": "mm",
                "hs_code": "4331767",
                "country_code": "GB",
                "img_path": "",
                "dangerous_goods":"No",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "non_returnable_message": ""
            }
        ]
    }
}

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <id>3103</id>
    <order_reference>12312359</order_reference>
    <order_date>1432958400</order_date>
    <contact_name>John Doe</contact_name>
    <company_name></company_name>
    <addr1>address line</addr1>
    <addr2></addr2>
    <addr3></addr3>
    <city>some address</city>
    <zip>20000</zip>
    <state>NY</state>
    <country>GB</country>
    <phone>+010557779</phone>
    <email>doe@gmail.com</email>
    <currency_code>EUR</currency_code>
    <rma></rma>
    <export_awb>444444US</export_awb>
    <export_carrier_name>USPS</export_carrier_name>
    <free_return>1</free_return>
    <item>
        <sku_code>ASD111</sku_code>
        <sku_desc>Black Sculpting  Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>5</quantity>
        <price>100</price>
        <cost_price>53.12</cost_price>
        <weight>0.3</weight>
        <weight_uom></weight_uom>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>5905954</hs_code>
        <country_code>CN</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>No</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <non_returnable_message>Some message</non_returnable_message>
    </item>
    <item>
        <sku_code>UN-12322;28</sku_code>
        <sku_desc>Black Halterneck  Corset</sku_desc>
        <quantity>10</quantity>
        <price>200</price>
        <cost_price>120.13</cost_price>
        <weight>0.86</weight>
        <weight_uom></weight_uom>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>4331767</hs_code>
        <country_code>GB</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>No</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <non_returnable_message></non_returnable_message>
    </item>
</success>

Order not found:

{
    "error": {
        "code": "order_nx",
        "message": [
            "Order not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>order_nx</code>
    <message>Order not found</message>
</error>

Input data

You can provide an order data in 2 formats: JSON, XML

JSON

{
    "order":
    {
        "type":"reference",
        "val":"600090343"
    }
}

XML

<order>
    <type>reference</type>
    <val>600090343</val>
</order>

Output data

Order successfully deleted:

{
    "success": {
        "message": "Order successfully deleted"
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <message>Order successfully deleted</message>
</success>

Order not found:

{
    "error": {
        "code": "order_nx",
        "message": [
            "Order not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>order_nx</code>
    <message>Order not found</message>
</error>
        

Input data

You can provide a filter data in 2 formats: JSON, XML

JSON

{
    "filter":
    {
        "date_from":"10/15/2015",
        "date_to":"12/01/2015",
        "quick_search":"GB"
    }
}

XML

<filter>
    <date_from>10/15/2015</date_from>
    <date_to>12/01/2015</date_to>
    <quick_search>GB</quick_search>
</filter>

Output data

JSON response example:

{
    "success": {
        "id": [
            "21",
            "25",
            "58",
            "57",
            "59",
            "42",
            "41",
            "39",
            "38",
            "37"
        ]
    }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <id>2901</id>
    <id>2902</id>
    <id>2903</id>
    <id>2904</id>
    <id>2906</id>
</success>
        

Nothing found:

{
    "error": {
        "code": "empty",
        "message": [
            "Nothing found."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>empty</code>
    <message>Nothing found.</message>
</error>

Input data

Order info (* required)

Item info (* required)

Item custom fields

You can provide an order data in 2 formats: JSON, XML

JSON

{
    "order":
    {
        "order_reference":"1000000000000",
        "item":[
            {
                "sku_code":"QWE123",
                "sku_desc":"Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity":"5",
                "price":"100",
                "cost_price": "13.12",
                "weight":"1",
                "length":"2",
                "width":"3",
                "height":"4",
                "dimensions_uom":"mm",
                "hs_code":"999999",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "tracking": "123456789",
                "non_returnable": "true",
                "non_returnable_message": "Body shapers are non returnable",
                "days_for_return": 0,
                "custom_fields": {
                    "field1": "Some additional description for this item"
                }
            },
            {
                "sku_code":"QWE456",
                "sku_desc":"Black Halterneck Corset",
                "quantity":"10",
                "price":"200",
                "cost_price": "25.12",
                "weight":"0.86",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"999999",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "tracking": "123456780",
                "days_for_return": 120
            }
        ]
    }
}

XML

<order>
    <order_reference>1000000000000</order_reference>
    <item>
        <sku_code>QWE123</sku_code>
        <sku_desc>Black Sculpting &amp; Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>5</quantity>
        <price>100</price>
        <cost_price>13.12</cost_price>
        <weight>0.3</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <country_code>CN</country_code>
        <hs_code>999999</hs_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>Yes</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <tracking>123456789</tracking>
        <non_returnable>true</non_returnable>
        <days_for_return>0</days_for_return>
        <custom_fields>
            <field1>Some additional description for this order</field1>
        </custom_fields>
    </item>
    <item>
        <sku_code>QWE456</sku_code>
        <sku_desc>Black Halterneck Corset</sku_desc>
        <quantity>10</quantity>
        <price>200</price>
        <cost_price>25.12</cost_price>
        <weight>0.86</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>999999</hs_code>
        <country_code>GB</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>Yes</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
        <tracking>123456780</tracking>
        <days_for_return>120</days_for_return>
    </item>
</order>

Output data

Orders items successfully added:

{
    "success": {
        "message": "Orders items successfully added",
        "order_reference": "1000000000000",
        "order_id": 10000
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <message>Orders items successfully added</message>
    <order_reference>12312355</order_reference>
    <order_id>10000000</order_id>
</success>

Request field order_reference is wrong:

{
    "error": {
        "code": "request_wrong",
        "message": [
            "Request field order_reference is wrong."
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>request_wrong</code>
    <message>Request field order_reference is wrong.</message>
</error>

Request field item is wrong:

{
    "error": {
        "code": "request_items_wrong",
        "message": [
            "Request field item is wrong."
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>request_items_wrong</code>
    <message>Request field item is wrong.</message>
</error>

Order with this order_reference not found:

{
    "error": {
        "code": "order_nx",
        "message": [
            "Order not found."
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>order_nx</code>
    <message>Order not found.</message>
</error>

JSON is not valid:

{
    "error": {
        "code": "json_invalid",
        "message": [
            "JSON is not valid"
        ]
    }
}
        

XML is not valid:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>xml_invalid</code>
    <message>XML is not valid</message>
</error>

Input data

Information of return (* required)

Address Info

collection_date

collection_address (Not required)

Item info (Not Required)

Reason info (Not Required)

You can provide a return data in 2 formats: JSON, XML

JSON

{
    "return":
    {
        "order_reference":"12312355",
        "name":"John Doe",
        "phone":"+010557779",
        "email":"doe@gmail.com",
        "addr1":"City Hall",
        "addr2":"24 Eagle Street, Room 102",
        "addr3":"",
        "city":"Albany",
        "zip":"12207",
        "state":"NY",
        "country":"US",
        "display_id":"123123123",
        "final_dest_id": "Default",
        "final_dest_addr1":"Telford Transport Solutions Ltd",
        "final_dest_addr2":"Stafford Park 12",
        "final_dest_addr3":"",
        "final_dest_city":"Telford",
        "final_dest_zip":"TF3 3BJ",
        "final_dest_state":"West Midlands",
        "final_dest_country":"UK",
        "carrier":"acp",
        "service":"ground",
        "item":[
            {
                "sku_code":"ASD111",
                "sku_desc":"Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity":"2",
                "price":"100",
                "cost_price":"92.01",
                "weight":"0.3",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"5905954",
                "country_code":"CN",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "reason": [
                    {
                        "action": "Refund",
                        "reason": "Incorrect item received",
                        "wish": "",
                        "additional": "Wrong size received",
                        "code": ""
                    },{
                        "action": "Refund",
                        "reason": "I don't want it any longer",
                        "wish": "",
                        "additional": "",
                        "code": ""
                    }
                ]
            },{
                "sku_code":"UN-12322;28",
                "sku_desc":"Black Halterneck > Corset",
                "quantity":"10",
                "price":"200",
                "cost_price":"92.01",
                "weight":"0.86",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"4331767",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"No",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS"
            }
        ]
    }
}

XML

<return>
    <order_reference>12312355</order_reference>
    <service_id>1</service_id>
    <phone>+010557779</phone>
    <email>doe@gmail.com</email>
    <display_id>123123123</display_id>
    <name>John Doe</name>
    <country>US</country>
    <state>NY</state>
    <zip>12207</zip>
    <city>Albany</city>
    <addr1>City Hall</addr1>
    <addr2>24 Eagle Street, Room 102</addr2>
    <addr3></addr3>
    <final_dest_id>Default</final_dest_id>
    <final_dest_country>UK</final_dest_country>
    <final_dest_state>West Midlands</final_dest_state>
    <final_dest_zip>TF3 3BJ</final_dest_zip>
    <final_dest_city>Telford</final_dest_city>
    <final_dest_addr1>Telford Transport Solutions Ltd</final_dest_addr1>
    <final_dest_addr2>Stafford Park 12</final_dest_addr2>
    <final_dest_addr3></final_dest_addr3>
    <item>
        <sku_code>ASD111</sku_code>
        <sku_desc>Black Sculpting &amp; Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>5</quantity>
        <price>100</price>
        <cost_price>92.01</price>
        <weight>0.3</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>5905954</hs_code>
        <country_code>CN</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>No</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
    </item>
    <item>
        <sku_code>UN-12322;28</sku_code>
        <sku_desc>Black Halterneck &gt; Corset</sku_desc>
        <quantity>10</quantity>
        <price>200</price>
        <cost_price>92.01</price>
        <weight>0.86</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>4331767</hs_code>
        <country_code>GB</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>No</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
    </item>
</return>

Output data

Return created successfully:

{
    "success": {
        "label": "base64 from pdf label file",
        "label_format": "pdf",
        "tracking": "526u8we",
        "first_mile_address": {
            "addr1": "Telford Transport Solutions Ltd",
            "addr2": "Stafford Park 12",
            "city": "Telford",
            "zip": "TF3 3BJ",
            "state": "Shropshire",
            "country": "GB",
            "additional_address": []
        },
        "secondary_barcode": "sec_526u8we"
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <label>base64 from pdf label file</label>
    <label_format>pdf</label_format>
    <tracking>526u8we</tracking>
    <first_mile_address>
        <addr1>BTG c/o Laser Transport</addr1>
        <addr2>Flosshafenstrasse 10</addr2>
        <city>Neuss</city>
        <zip>41460</zip>
        <state>Neuss</state>
        <country>DE</country>
        <additional_address></additional_address>
    </first_mile_address>
    <secondary_barcode>sec_526u8we</secondary_barcode>
</success>

Incorrect return data:

{
    "error": {
        "code": "return_invalid",
        "message": [
            "Field order_reference can not be empty."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_invalid</code>
    <message>Field order_reference can not be empty.</message>
</error>

JSON is not valid:

{
    "error": {
        "code": "json_invalid",
        "message": [
            "JSON is not valid"
        ]
    }
}
        

XML is not valid:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>xml_invalid</code>
    <message>XML is not valid</message>
</error>

Input data

You can provide a filter data in 2 formats: JSON, XML

JSON

{
    "filter":
    {
        "tracking": "",
        "date_from":"10/15/2015",
        "date_to":"12/01/2015"
    }
}

XML

<filter>
    <tracking></tracking>
    <date_from>10/15/2015</date_from>
    <date_to>12/01/2015</date_to>
</filter>

Output data

JSON response example:

{
    "success": {
        "id": [
            "2901",
            "2902",
            "2903",
            "2904",
            "2906"
        ]
    }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <id>2901</id>
    <id>2902</id>
    <id>2903</id>
    <id>2904</id>
    <id>2906</id>
</success>
        

Nothing found:

{
    "error": {
        "code": "empty",
        "message": [
            "Nothing found."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>empty</code>
    <message>Nothing found.</message>
</error>

Input data

Return info

You can provide a search data in 2 formats: JSON, XML

JSON

{
    "return":
    {
        "id":"2901"
    }
}

XML

<return>
    <id>2901</id>
</return>

Output data

Data found:

Response fields. Return info.

Address Info

Item info

Return custom fields

Item custom fields

JSON response example:

{
    "success": {
        "id": "111495",
        "order_reference": "12312355",
        "date_added": "1465397894",
        "name": "John Doe",
        "zip": "12207",
        "email": "doe@gmail.com",
        "addr1": "City Hall",
        "addr2": "24 Eagle Street, Room 102",
        "addr3": "",
        "city": "Albany",
        "state": "NY",
        "country": "US",
        "phone": "+010557779",
        "tracking": "9202490112676104136413",
        "tracking_last_update": "1465397894",
        "current_tracking_status": "10",
        "final_dest_id": "Default",
        "final_dest_addr1": "Telford Transport Solutions Ltd",
        "final_dest_addr2": "Stafford Park 12",
        "final_dest_addr3": "",
        "final_dest_city": "Telford",
        "final_dest_zip": "TF3 3BJ",
        "final_dest_state": "West Midlands",
        "final_dest_country": "UK",
        "verification_entity": 0,
        "item": [
            {
                "sku_code": "ASD111",
                "sku_desc": "Black Sculpting Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity": "3",
                "price": "100",
                "cost_price": "13.12",
                "weight": "0.3",
                "weight_uom": "",
                "length": "",
                "width": "",
                "height": "",
                "dimensions_uom": "mm",
                "hs_code": "5905954",
                "country_code": "CN",
                "img_path": "",
                "dangerous_goods":"No",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "final_dest_name": "",
                "final_dest_company_name": "",
                "final_dest_id": "",
                "final_dest_country":"",
                "final_dest_state":"",
                "final_dest_zip":"",
                "final_dest_city":"",
                "final_dest_addr1":"",
                "final_dest_addr2":"",
                "final_dest_addr3":"",
                "final_dest_neighborhood":"",
                "verification_entity": 0,
                "final_disposition": "",
                "reason": [
                    {
                        "action": "Exchange",
                        "reason": "Too small",
                        "wish": "",
                        "additional": {
                            "title": "New size",
                            "value": "L"
                        }
                    },
                    {
                        "action": "Refund",
                        "reason": "Faulty",
                        "wish": "",
                        "additional": {
                            "title": "",
                            "value": ""
                        }
                    },
                    {
                        "action": "Donate",
                        "reason": "Not useful",
                        "wish": "",
                        "additional": {
                            "title": "",
                            "value": ""
                        }
                    }
                ],
                "custom_fields": {
                    "field1": "size XXL",
                    "field3": "color GREEN",
                }
            },
            {
                "sku_code": "UN-12322;28",
                "sku_desc": "Black Halterneck Corset",
                "quantity": "2",
                "price": "200",
                "weight": "0.86",
                "weight_uom": "",
                "length": "",
                "width": "",
                "height": "",
                "dimensions_uom": "mm",
                "hs_code": "4331767",
                "country_code": "GB",
                "img_path": "",
                "dangerous_goods":"No",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS",
                "final_dest_name": "",
                "final_dest_company_name": "",
                "final_dest_id": "",
                "final_dest_country":"",
                "final_dest_state":"",
                "final_dest_zip":"",
                "final_dest_city":"",
                "final_dest_addr1":"",
                "final_dest_addr2":"",
                "final_dest_addr3":"",
                "final_dest_neighborhood":"",
                "verification_entity": 0,
                "final_disposition": "",
                "reason": [
                    {
                        "action": "Exchange",
                        "reason": "Too small",
                        "wish": "",
                        "additional": {
                            "title": "New size",
                            "value": "L"
                        }
                    },
                    {
                        "action": "Recycle",
                        "reason": "Broken",
                        "wish": "",
                        "additional": {
                            "title": "",
                            "value": ""
                        }
                    }
                ],
                "custom_fields": {
                    "field1": "size 38",
                    "field2": "season winter",
                }
            }
        ],
        "carrier": "ACP",
        "label": "base64 code from label",
        "custom_fields": {
            "field1": "test order",
            "field3": "total sail",
        }
    }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <id>1227433</id>
    <order_reference>592edd0ef033e</order_reference>
    <date_added>1496243473</date_added>
    <name>John Doe</name>
    <company_name></company_name>
    <zip>12207</zip>
    <email>doe@gmail.com</email>
    <addr1>City Hall</addr1>
    <addr2>24 Eagle Street, Room 102</addr2>
    <addr3>Address line 3</addr3>
    <city>Albany</city>
    <state>NY</state>
    <country>US</country>
    <phone>+010557779</phone>
    <display_id>test display_id</display_id>
    <external_id></external_id>
    <final_dest_addr1>test final_dest_addr1</final_dest_addr1>
    <final_dest_addr2>test final_dest_addr2</final_dest_addr2>
    <final_dest_addr3>test final_dest_addr3</final_dest_addr3>
    <final_dest_city>test final_dest_city</final_dest_city>
    <final_dest_country>US</final_dest_country>
    <final_dest_state>test final_dest_state</final_dest_state>
    <final_dest_zip>test final_dest_zip</final_dest_zip>
    <final_dest_name></final_dest_name>
    <final_dest_company_name></final_dest_company_name>
    <final_dest_id></final_dest_id>
    <tracking>9202490112676107421264</tracking>
    <tracking_last_update>1496243476</tracking_last_update>
    <current_tracking_status>10</current_tracking_status>
    <verification_entity>0</verification_entity>
    <item>
        <sku_code>ASD111</sku_code>
        <sku_desc>Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>1</quantity>
        <price>100</price>
        <weight>0.3</weight>
        <weight_uom></weight_uom>
        <length></length>
        <width></width>
        <height></height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>5905954</hs_code>
        <country_code>CN</country_code>
        <img_path></img_path>
        <dangerous_goods>yes</dangerous_goods>
        <tracking></tracking>
        <export_date></export_date>
        <export_awb></export_awb>
        <export_carrier_name></export_carrier_name>
        <final_dest_name>final_dest_name-585022238</final_dest_name>
        <final_dest_company_name>final_dest_company_name-545265771</final_dest_company_name>
        <final_dest_id>final_dest_id-1404626025</final_dest_id>
        <final_dest_country>GB</final_dest_country>
        <final_dest_state>final_dest_state-1609489232</final_dest_state>
        <final_dest_zip>final_dest_zip-449086755</final_dest_zip>
        <final_dest_city>final_dest_city-39385187</final_dest_city>
        <final_dest_addr1>final_dest_add1-412216264</final_dest_addr1>
        <final_dest_addr2>final_dest_add2-565416059</final_dest_addr2>
        <final_dest_addr3>final_dest_add3-213443</final_dest_addr3>
        <final_dest_neighborhood>final_dest_neighborhood-438927438</final_dest_neighborhood>
        <verification_entity></verification_entity>
        <final_disposition>return</final_disposition>
        <reason>
            <action></action>
            <reason></reason>
            <wish></wish>
            <additional>
                <title></title>
                <value></value>
            </additional>
        </reason>
        <custom_fields>
            <field1>QWERTY</field1>
            <field2>2344-43</field2>
        </custom_fields>
    </item>
    <item>
        <sku_code>UN-12322;28</sku_code>
        <sku_desc>Black Halterneck > Corset</sku_desc>
        <quantity>1</quantity>
        <price>200</price>
        <weight>0.86</weight>
        <weight_uom></weight_uom>
        <length></length>
        <width></width>
        <height></height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>4331767</hs_code>
        <country_code>GB</country_code>
        <img_path></img_path>
        <dangerous_goods>no</dangerous_goods>
        <tracking></tracking>
        <export_date></export_date>
        <export_awb></export_awb>
        <export_carrier_name></export_carrier_name>
        <final_dest_name>final_dest_name-1105732117</final_dest_name>
        <final_dest_company_name>final_dest_company_name-397946632</final_dest_company_name>
        <final_dest_id>final_dest_id-1065831170</final_dest_id>
        <final_dest_country>UA</final_dest_country>
        <final_dest_state>final_dest_state-1311145863</final_dest_state>
        <final_dest_zip>final_dest_zip-1975861483</final_dest_zip>
        <final_dest_city>final_dest_city-1167678823</final_dest_city>
        <final_dest_addr1>final_dest_addr1-359905225</final_dest_addr1>
        <final_dest_addr2>final_dest_addr2-1327024868</final_dest_addr2>
        <final_dest_addr3>final_dest_addr3-311700808</final_dest_addr3>
        <final_dest_neighborhood>final_dest_neighborhood-1967127881</final_dest_neighborhood>
        <verification_entity></verification_entity>
        <final_disposition>destroy</final_disposition>
        <reason>
            <action></action>
            <reason></reason>
            <wish></wish>
            <additional>
                <title></title>
                <value></value>
            </additional>
        </reason>
    </item>
    <carrier>ACP</carrier>
    <label>base64 code from label</label>
    <custom_fields>
        <field1>test order</field1>
        <field3>field #3</field3>
    </custom_fields>
</success>
        

Return not found:

{
    "error": {
        "code": "return_nx",
        "message": [
            "Return not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_nx</code>
    <message>Return not found</message>
</error>
        

Input data

Filter data

You can provide an order data in 2 formats: JSON, XML

JSON

{
    "filter":
    {
        "date_from":"10/15/2015",
        "date_to":"12/01/2015"
    }
}

XML

<filter>
    <date_from>10/15/2015</date_from>
    <date_to>12/01/2015</date_to>
</filter>

Output data

Data found:

Response fields. Return info.

JSON response example:

{
    "success": {
        "total": "2",
        "return": [
            {
                "id": "111495",
                "order_reference": "12312355",
                "date_added": "1465397894",
                "name": "John Doe",
                "zip": "12207",
                "email": "doe@gmail.com",
                "addr1": "City Hall",
                "addr2": "24 Eagle Street, Room 102",
                "addr3": "",
                "city": "Albany",
                "state": "NY",
                "country": "US",
                "phone": "+010557779",
                "tracking": "9202490112676104136413",
                "tracking_last_update": "1465397894",
                "current_tracking_status": "10",
                "verification_entity": 0,
                "item": [
                    {
                        "sku_code": "ASD111",
                        "sku_desc": "Black Sculpting Smoothing Shapewear Body Suit-EUR 38 (M)",
                        "quantity": "3",
                        "price": "100",
                        "weight": "0.3",
                        "weight_uom": "",
                        "length": "",
                        "width": "",
                        "height": "",
                        "dimensions_uom": "mm",
                        "hs_code": "5905954",
                        "country_code": "CN",
                        "img_path": "",
                        "dangerous_goods":"No",
                        "export_date": "946677600",
                        "export_awb": "32153454GB",
                        "export_carrier_name": "USPS",
                        "final_dest_name": "",
                        "final_dest_company_name": "",
                        "final_dest_id": "",
                        "final_dest_country":"",
                        "final_dest_state":"",
                        "final_dest_zip":"",
                        "final_dest_city":"",
                        "final_dest_addr1":"",
                        "final_dest_addr2":"",
                        "final_dest_addr3":"",
                        "final_dest_neighborhood":"",
                        "verification_entity": 0,
                        "final_disposition": "",
                        "reason": [
                            {
                                "action": "Exchange",
                                "reason": "Too small",
                                "wish": "",
                                "additional": {
                                    "title": "New size",
                                    "value": "L"
                                }
                            },
                            {
                                "action": "Refund",
                                "reason": "Faulty",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            },
                            {
                                "action": "Donate",
                                "reason": "Not useful",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            }
                        ]
                    },
                    {
                        "sku_code": "UN-12322;28",
                        "sku_desc": "Black Halterneck Corset",
                        "quantity": "2",
                        "price": "200",
                        "weight": "0.86",
                        "weight_uom": "",
                        "length": "",
                        "width": "",
                        "height": "",
                        "dimensions_uom": "mm",
                        "hs_code": "4331767",
                        "country_code": "GB",
                        "img_path": "",
                        "dangerous_goods":"No",
                        "export_date": "946677600",
                        "export_awb": "32153454GB",
                        "export_carrier_name": "USPS",
                        "final_dest_name": "",
                        "final_dest_company_name": "",
                        "final_dest_id": "",
                        "final_dest_country":"",
                        "final_dest_state":"",
                        "final_dest_zip":"",
                        "final_dest_city":"",
                        "final_dest_addr1":"",
                        "final_dest_addr2":"",
                        "final_dest_addr3":"",
                        "final_dest_neighborhood":"",
                        "verification_entity": 0,
                        "final_disposition": "",
                        "reason": [
                            {
                                "action": "Exchange",
                                "reason": "Too small",
                                "wish": "",
                                "additional": {
                                    "title": "New size",
                                    "value": "L"
                                }
                            },
                            {
                                "action": "Recycle",
                                "reason": "Broken",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            },
                        ]
                    }
                ],
                "carrier": "ACP"
            },
            {
                "id": "111494",
                "order_reference": "12312355",
                "date_added": "1465397745",
                "name": "John Doe",
                "zip": "12207",
                "email": "doe@gmail.com",
                "addr1": "City Hall",
                "addr2": "24 Eagle Street, Room 102",
                "city": "Albany",
                "state": "NY",
                "country": "US",
                "phone": "+010557779",
                "tracking": "9202490112676104136369",
                "tracking_last_update": "1465397745",
                "current_tracking_status": "10",
                "verification_entity": 0,
                "item": [
                    {
                        "sku_code": "ASD111",
                        "sku_desc": "Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)",
                        "quantity": "3",
                        "price": "100",
                        "weight": "0.3",
                        "weight_uom": "",
                        "length": "",
                        "width": "",
                        "height": "",
                        "dimensions_uom": "mm",
                        "hs_code": "5905954",
                        "country_code": "CN",
                        "img_path": "",
                        "dangerous_goods":"No",
                        "export_date": "946677600",
                        "export_awb": "32153454GB",
                        "export_carrier_name": "USPS",
                        "final_dest_name": "",
                        "final_dest_company_name": "",
                        "final_dest_id": "",
                        "final_dest_country":"",
                        "final_dest_state":"",
                        "final_dest_zip":"",
                        "final_dest_city":"",
                        "final_dest_addr1":"",
                        "final_dest_addr2":"",
                        "final_dest_addr3":"",
                        "final_dest_neighborhood":"",
                        "verification_entity": 0,
                        "final_disposition": "",
                        "reason": [
                            {
                                "action": "Exchange",
                                "reason": "Too small",
                                "wish": "",
                                "additional": {
                                    "title": "New size",
                                    "value": "L"
                                }
                            },
                            {
                                "action": "Refund",
                                "reason": "Faulty",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            },
                            {
                                "action": "Donate",
                                "reason": "Not useful",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            }
                        ]
                    },
                    {
                        "sku_code": "UN-12322;28",
                        "sku_desc": "Black Halterneck > Corset",
                        "quantity": "2",
                        "price": "200",
                        "weight": "0.86",
                        "weight_uom": "",
                        "length": "",
                        "width": "",
                        "height": "",
                        "dimensions_uom": "mm",
                        "hs_code": "4331767",
                        "country_code": "GB",
                        "img_path": "",
                        "dangerous_goods":"No",
                        "export_date": "946677600",
                        "export_awb": "32153454GB",
                        "export_carrier_name": "USPS",
                        "final_dest_name": "",
                        "final_dest_company_name": "",
                        "final_dest_id": "",
                        "final_dest_country":"",
                        "final_dest_state":"",
                        "final_dest_zip":"",
                        "final_dest_city":"",
                        "final_dest_addr1":"",
                        "final_dest_addr2":"",
                        "final_dest_addr3":"",
                        "final_dest_neighborhood":"",
                        "verification_entity": 0,
                        "final_disposition": "",
                        "reason": [
                            {
                                "action": "Exchange",
                                "reason": "Too small",
                                "wish": "",
                                "additional": {
                                    "title": "New size",
                                    "value": "L"
                                }
                            },
                            {
                                "action": "Recycle",
                                "reason": "Broken",
                                "wish": "",
                                "additional": {
                                    "title": "",
                                    "value": ""
                                }
                            },

                        ]
                    }
                ],
                "carrier": "ACP"
            }
        ]
    }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <total>2</total>
    <return>
        <id>813253</id>
        <order_reference>246248138</order_reference>
        <date_added>1487634969</date_added>
        <name>GIANNAKOUDAKI EIRINI</name>
        <company_name></company_name>
        <zip>14569</zip>
        <email>eyannn@hotmail.com</email>
        <addr1>Amygdaleas 6A Aniksi</addr1>
        <addr2></addr2>
        <addr3></addr3>
        <city>Athens</city>
        <state>Aniksi</state>
        <country>GR</country>
        <phone></phone>
        <display_id>246248138</display_id>
        <external_id></external_id>
        <final_dest_addr1></final_dest_addr1>
        <final_dest_addr2></final_dest_addr2>
        <final_dest_addr3></final_dest_addr3>
        <final_dest_city></final_dest_city>
        <final_dest_country></final_dest_country>
        <final_dest_state></final_dest_state>
        <final_dest_zip></final_dest_zip>
        <final_dest_name></final_dest_name>
        <final_dest_company_name></final_dest_company_name>
        <final_dest_id></final_dest_id>
        <tracking>00340435014611159001</tracking>
        <tracking_last_update>1487634969</tracking_last_update>
        <current_tracking_status>10</current_tracking_status>
        <verification_entity>0</verification_entity>
        <item>
            <sku_code>ASD111</sku_code>
            <sku_desc>Black Sculpting Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
            <quantity>3</quantity>
            <price>100</price>
            <weight>0.3</weight>
            <weight_uom></weight_uom>
            <length></length>
            <width></width>
            <height></height>
            <dimensions_uom>mm</dimensions_uom>
            <hs_code>5905954</hs_code>
            <country_code>CN</country_code>
            <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
            <dangerous_goods>No</dangerous_goods>
            <export_date>946677600</export_date>
            <export_awb>32153454GB</export_awb>
            <export_carrier_name>USPS</export_carrier_name>
            <final_dest_name></final_dest_name>
            <final_dest_company_name></final_dest_company_name>
            <final_dest_id></final_dest_id>
            <final_dest_country></final_dest_country>
            <final_dest_state></final_dest_state>
            <final_dest_zip></final_dest_zip>
            <final_dest_city></final_dest_city>
            <final_dest_addr1></final_dest_addr1>
            <final_dest_addr2></final_dest_addr2>
            <final_dest_addr3></final_dest_addr3>
            <final_dest_neighborhood></final_dest_neighborhood>
            <verification_entity>0</verification_entity>
            <final_disposition></final_disposition>
            <reason>
                <action>Exchange</action>
                <reason>Too small</reason>
                <wish></wish>
                <additional>
                    <title>New size</title>
                    <value>L</value>
                </additional>
            </reason>
            <reason>
                <action>Refund</action>
                <reason>Faulty</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
            <reason>
                <action>Donate</action>
                <reason>No useful</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
        </item>
        <item>
            <sku_code>UN-12322;28</sku_code>
            <sku_desc>Black Halterneck Corset</sku_desc>
            <quantity>2</quantity>
            <price>200</price>
            <weight>0.86</weight>
            <weight_uom></weight_uom>
            <length></length>
            <width></width>
            <height></height>
            <dimensions_uom>mm</dimensions_uom>
            <hs_code>4331767</hs_code>
            <country_code>GB</country_code>
            <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
            <dangerous_goods>No</dangerous_goods>
            <export_date>946677600</export_date>
            <export_awb>32153454GB</export_awb>
            <export_carrier_name>USPS</export_carrier_name>
            <final_dest_name></final_dest_name>
            <final_dest_company_name></final_dest_company_name>
            <final_dest_id></final_dest_id>
            <final_dest_country></final_dest_country>
            <final_dest_state></final_dest_state>
            <final_dest_zip></final_dest_zip>
            <final_dest_city></final_dest_city>
            <final_dest_addr1></final_dest_addr1>
            <final_dest_addr2></final_dest_addr2>
            <final_dest_addr3></final_dest_addr3>
            <final_dest_neighborhood></final_dest_neighborhood>
            <verification_entity>0</verification_entity>
            <final_disposition></final_disposition>
            <reason>
                <action>Exchange</action>
                <reason>Too small</reason>
                <wish></wish>
                <additional>
                    <title>New size</title>
                    <value>L</value>
                </additional>
            </reason>
            <reason>
                <action>Recycle</action>
                <reason>Broken</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
        </item>
        <carrier>DHL</carrier>
    </return>
    <return>
        <id>813252</id>
        <order_reference>250483484</order_reference>
        <date_added>1487634904</date_added>
        <name>Dominika Stasiak</name>
        <company_name></company_name>
        <zip>62-800</zip>
        <email>chococat@hotmail.co.uk</email>
        <addr1>Legionow 24-26/27</addr1>
        <addr2></addr2>
        <addr3></addr3>
        <city>Kalisz</city>
        <state>Wielkopolska</state>
        <country>PL</country>
        <phone>0048514100805</phone>
        <display_id>250483484</display_id>
        <external_id></external_id>
        <final_dest_addr1></final_dest_addr1>
        <final_dest_addr2></final_dest_addr2>
        <final_dest_addr3></final_dest_addr3>
        <final_dest_city></final_dest_city>
        <final_dest_country></final_dest_country>
        <final_dest_state></final_dest_state>
        <final_dest_zip></final_dest_zip>
        <final_dest_name></final_dest_name>
        <final_dest_company_name></final_dest_company_name>
        <final_dest_id></final_dest_id>
        <tracking>514500212847</tracking>
        <tracking_last_update>1488412800</tracking_last_update>
        <current_tracking_status>60</current_tracking_status>
        <verification_entity>0</verification_entity>
        <item>
            <sku_code>ASD111</sku_code>
            <sku_desc>Black Sculpting &amp; Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
            <quantity>3</quantity>
            <price>100</price>
            <weight>0.3</weight>
            <weight_uom></weight_uom>
            <length></length>
            <width></width>
            <height></height>
            <dimensions_uom>mm</dimensions_uom>
            <hs_code>5905954</hs_code>
            <country_code>CN</country_code>
            <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
            <dangerous_goods>No</dangerous_goods>
            <export_date>946677600</export_date>
            <export_awb>32153454GB</export_awb>
            <export_carrier_name>USPS</export_carrier_name>
            <final_dest_name></final_dest_name>
            <final_dest_company_name></final_dest_company_name>
            <final_dest_id></final_dest_id>
            <final_dest_country></final_dest_country>
            <final_dest_state></final_dest_state>
            <final_dest_zip></final_dest_zip>
            <final_dest_city></final_dest_city>
            <final_dest_addr1></final_dest_addr1>
            <final_dest_addr2></final_dest_addr2>
            <final_dest_addr3></final_dest_addr3>
            <final_dest_neighborhood></final_dest_neighborhood>
            <verification_entity>0</verification_entity>
            <final_disposition></final_disposition>
            <reason>
                <action>Exchange</action>
                <reason>Too small</reason>
                <wish></wish>
                <additional>
                    <title>New size</title>
                    <value>L</value>
                </additional>
            </reason>
            <reason>
                <action>Refund</action>
                <reason>Faulty</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
            <reason>
                <action>Donate</action>
                <reason>No useful</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
        </item>
        <item>
            <sku_code>UN-12322;28</sku_code>
            <sku_desc>Black Halterneck &gt; Corset</sku_desc>
            <quantity>2</quantity>
            <price>200</price>
            <weight>0.86</weight>
            <weight_uom></weight_uom>
            <length></length>
            <width></width>
            <height></height>
            <dimensions_uom>mm</dimensions_uom>
            <hs_code>4331767</hs_code>
            <country_code>GB</country_code>
            <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
            <dangerous_goods>No</dangerous_goods>
            <export_date>946677600</export_date>
            <export_awb>32153454GB</export_awb>
            <export_carrier_name>USPS</export_carrier_name>
            <final_dest_name></final_dest_name>
            <final_dest_company_name></final_dest_company_name>
            <final_dest_id></final_dest_id>
            <final_dest_country></final_dest_country>
            <final_dest_state></final_dest_state>
            <final_dest_zip></final_dest_zip>
            <final_dest_city></final_dest_city>
            <final_dest_addr1></final_dest_addr1>
            <final_dest_addr2></final_dest_addr2>
            <final_dest_addr3></final_dest_addr3>
            <final_dest_neighborhood></final_dest_neighborhood>
            <verification_entity>0</verification_entity>
            <final_disposition></final_disposition>
            <reason>
                <action>Exchange</action>
                <reason>Too small</reason>
                <wish></wish>
                <additional>
                    <title>New size</title>
                    <value>L</value>
                </additional>
            </reason>
             <reason>
                <action>Recycle</action>
                <reason>Broken</reason>
                <wish></wish>
                <additional>
                    <title></title>
                    <value></value>
                </additional>
            </reason>
        </item>
        <carrier>DHL</carrier>
    </return>
</success>
        

Return not found:

{
    "error": {
        "code": "return_nx",
        "message": [
            "Return not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_nx</code>
    <message>Return not found</message>
</error>
        

Input data

Information of return

Address Info

Item info

collection_address (Not required)

You can provide data in 2 formats: JSON, XML

JSON

{
    "return":
    {
        "order_reference":"12312355",
        "name":"John Doe",
        "phone":"+010557779",
        "email":"doe@gmail.com",
        "addr1":"City Hall",
        "addr2":"24 Eagle Street, Room 102",
        "addr3":"",
        "city":"Albany",
        "zip":"12207",
        "state":"NY",
        "country":"US",
        "final_dest_id": "Default",
        "final_dest_addr1":"Telford Transport Solutions Ltd",
        "final_dest_addr2":"Stafford Park 12",
        "final_dest_addr3":"",
        "final_dest_city":"Telford",
        "final_dest_zip":"TF3 3BJ",
        "final_dest_state":"West Midlands",
        "final_dest_country":"UK",
        "currency_code":"USD",
        "item":[
            {
                "sku_code":"ASD111",
                "sku_desc":"Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)",
                "quantity":"5",
                "price":"100",
                "weight":"0.3",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"5905954",
                "country_code":"CN",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"No",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS"
            },{
                "sku_code":"UN-12322;28",
                "sku_desc":"Black Halterneck > Corset",
                "quantity":"10",
                "price":"200",
                "weight":"0.86",
                "length":"10",
                "width":"10",
                "height":"10",
                "dimensions_uom":"mm",
                "hs_code":"4331767",
                "country_code":"GB",
                "img_path":"https://intelligentreturns.net/assets/frontend/img/rebound_logo.png",
                "dangerous_goods":"Yes",
                "export_date": "946677600",
                "export_awb": "32153454GB",
                "export_carrier_name": "USPS"
            }
        ]
    }
}

XML

<return>
    <order_reference>12312355</order_reference>
    <currency_code>USD</currency_code>
    <phone>+010557779</phone>
    <email>doe@gmail.com</email>
    <name>John Doe</name>
    <country>US</country>
    <state>NY</state>
    <zip>12207</zip>
    <city>Albany</city>
    <addr1>City Hall</addr1>
    <addr2>24 Eagle Street, Room 102</addr2>
    <addr3></addr3>
    <final_dest_id>Default</final_dest_id>
    <final_dest_country>UK</final_dest_country>
    <final_dest_state>West Midlands</final_dest_state>
    <final_dest_zip>TF3 3BJ</final_dest_zip>
    <final_dest_city>Telford</final_dest_city>
    <final_dest_addr1>Telford Transport Solutions Ltd</final_dest_addr1>
    <final_dest_addr2>Stafford Park 12</final_dest_addr2>
    <final_dest_addr3></final_dest_addr3>
    <item>
        <sku_code>ASD111</sku_code>
        <sku_desc>Black Sculpting &amp; Smoothing Shapewear Body Suit-EUR 38 (M)</sku_desc>
        <quantity>5</quantity>
        <price>100</price>
        <weight>0.3</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>5905954</hs_code>
        <country_code>CN</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>Yes</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
    </item>
    <item>
        <sku_code>UN-12322;28</sku_code>
        <sku_desc>Black Halterneck &gt; Corset</sku_desc>
        <quantity>10</quantity>
        <price>200</price>
        <weight>0.86</weight>
        <length>10</length>
        <width>10</width>
        <height>10</height>
        <dimensions_uom>mm</dimensions_uom>
        <hs_code>4331767</hs_code>
        <country_code>GB</country_code>
        <img_path>https://intelligentreturns.net/assets/frontend/img/rebound_logo.png</img_path>
        <dangerous_goods>No</dangerous_goods>
        <export_date>946677600</export_date>
        <export_awb>32153454GB</export_awb>
        <export_carrier_name>USPS</export_carrier_name>
    </item>
</return>

Output data

Response fields.

collection_dates

Successful request for prices:

{
   "success": {
      "result": [
         {
            "carrier": "asm",
            "service": "home_collection",
            "service_id": 16,
            "service_name": "Home Collection",
            "type": "home_collection",
            "description": "Your parcel will be collected from your preferred location on a date convenient for you.",
            "max_weight": "2kg",
            "max_dim": "L < 220cm",
            "avg_delivery_info": "10 days",
            "first_mile_price": "8.76 USD",
            "parcel_processing_price": "0 USD",
            "final_mile_price": "4.33 USD",
            "customs_price": "0 USD",
            "government_duty_price": "0 USD",
            "collection_dates": [
                {
                    "date": "2017/05/05",
                    "time_from": "08:00",
                    "time_to": "19:00",
                    "minimum_interval": 2
                },
                {
                    "date": "2017/05/06",
                    "time_from": "08:00",
                    "time_to": "19:00",
                    "minimum_interval": 2
                },
                {
                    "date": "2017/05/08",
                    "time_from": "08:00",
                    "time_to": "19:00",
                    "minimum_interval": 2
                },
                {
                    "date": "2017/05/09",
                    "time_from": "08:00",
                    "time_to": "19:00",
                    "minimum_interval": 2
                }
            ],
            "label_format": "pdf"
         }
      ]
   }
}
                    

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <result>
        <carrier>ams</carrier>
        <service>home_collection</service>
        <service_id>16</service_id>
        <service_name>Home Collection</service_name>
        <type>home_collection</type>
        <description>Your parcel will be collected from your preferred location on a date convenient for you.</description>
        <max_weight>25kg</max_weight>
        <max_dim>L < 220cm</max_dim>
        <avg_delivery_info>10 days</avg_delivery_info>
        <first_mile_price>8.76 USD</first_mile_price>
        <parcel_processing_price>0 USD</parcel_processing_price>
        <final_mile_price>4.33 USD</final_mile_price>
        <customs_price>0 USD</customs_price>
        <government_duty_price>0 USD</government_duty_price>
        <collection_dates>
            <date>2017/05/05</date>
            <time_from>08:00</time_from>
            <time_to>19:00</time_to>
            <minimum_interval>2</minimum_interval>
        </collection_dates>
        <collection_dates>
            <date>2017/05/06</date>
            <time_from>08:00</time_from>
            <time_to>19:00</time_to>
            <minimum_interval>2</minimum_interval>
        </collection_dates>
        <collection_dates>
            <date>2017/05/08</date>
            <time_from>08:00</time_from>
            <time_to>19:00</time_to>
            <minimum_interval>2</minimum_interval>
        </collection_dates>
        <collection_dates>
            <date>2017/05/09</date>
            <time_from>08:00</time_from>
            <time_to>19:00</time_to>
            <minimum_interval>2</minimum_interval>
        </collection_dates>
        <label_format>pdf</label_format>
    </result>
</success>

Incorrect return data:

{
    "error": {
        "code": "return_invalid",
        "message": [
            "Field order_reference cannot be empty."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_invalid</code>
    <message>Field order_reference cannot be empty.</message>
</error>

JSON is not valid:

{
    "error": {
        "code": "json_invalid",
        "message": [
            "JSON is not valid"
        ]
    }
}
        

XML is not valid:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>xml_invalid</code>
    <message>XML is not valid</message>
</error>

Input data

Return info

You can provide a return data in 2 formats: JSON, XML

JSON

{
    "return":
    {
        "tracking":"00350559268103460351"
    }
}
                                    

XML

<return>
    <tracking>00350559268103460351</tracking>
</return>
                                    

Output data

Return cancel requested successfully:

{
   "success": {
      "result": {
         "message": "Return cancel requested",
         "tracking": "ZF858435144GB",
         "external_id": "",
         "status": "Return cancel requested"
      }
   }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<success>
   <result>
      <message>Return cancel requested</message>
      <tracking>ZF858435100GB</tracking>
      <external_id />
      <status>Return cancel requested</status>
   </result>
</success>
        

Return not found:

{
    "error": {
        "code": "return_nx",
        "message": [
            "Return not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_nx</code>
    <message>Return not found</message>
</error>

Input data

Return info

You can provide a return data in 2 formats: JSON, XML

JSON

{
    "return":
    {
        "order_reference":"Order reference"
    }
}
                                    

XML

<return>
    <order_reference>Order reference</order_reference>
</return>
                                    

Output data

Response fields.

Transaction object

Return billing requested successfully:

{
  "success": {
    "returns": [
      {
        "order_reference": "Order reference",
        "tracking": "Tracking1",
        "external_id": "",
        "current_tracking_status": "60",
        "date_added": "1465397894",
        "end_buyer": {
          "transactions": [
            {
              "amount": "5.00",
              "currency": "GBP",
              "comment": "Return 'Order reference' was paid by customer."
            }
          ],
          "total": {
            "GBP": "5.00",
            "EUR": "5.54",
            "USD": "6.38"
          }
        },
        "contractual_amount": {
          "transactions": [
            {
              "amount": "6.00",
              "currency": "EUR",
              "comment": "Return 'Order reference' was billed by tracking event: Received by the carrier. 1 parcel billed"
            },
            {
              "amount": "7.00",
              "currency": "USD",
              "comment": "Return 'Order reference' was billed by tracking event: Delivered to the retailer. 1 parcel billed "
            }
          ],
          "total": {
            "GBP": "10.89",
            "EUR": "12.07",
            "USD": "13.92"
          }
        },
        "approximate_invoice_amount": {
          "GBP": "5.89",
          "EUR": "6.53",
          "USD": "7.54"
        }
      },
      {
        "order_reference": "Order reference",
        "tracking": "Tracking2",
        "external_id": "",
        "current_tracking_status": "60",
        "date_added": "1465398894",
        "end_buyer": {
          "transactions": [
            {
              "amount": "5.00",
              "currency": "GBP",
              "comment": "Return 'Order reference' was paid by customer."
            }
          ],
          "total": {
            "GBP": "5.00",
            "EUR": "5.54",
            "USD": "6.38"
          }
        },
        "contractual_amount": {
          "transactions": [
            {
              "amount": "6.00",
              "currency": "EUR",
              "comment": "Return 'Order reference' was billed by tracking event: Received by the carrier. 1 parcel billed"
            },
            {
              "amount": "7.00",
              "currency": "USD",
              "comment": "Return 'Order reference' was billed by tracking event: Delivered to the retailer. 1 parcel billed "
            }
          ],
          "total": {
            "GBP": "10.89",
            "EUR": "12.07",
            "USD": "13.92"
          }
        },
        "approximate_invoice_amount": {
          "GBP": "5.89",
          "EUR": "6.53",
          "USD": "7.54"
        }
      }
    ]
  }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <returns>
        <order_reference>Order reference</order_reference>
        <tracking>Tracking1</tracking>
        <external_id></external_id>
        <current_tracking_status>60</current_tracking_status>
        <date_added>1465397894</date_added>
        <end_buyer>
            <transactions>
                <amount>5.00</amount>
                <currency>GBP</currency>
                <comment>Return 'Order reference' was paid by customer.</comment>
            </transactions>
            <total>
                <GBP>5.00</GBP>
                <EUR>5.54</EUR>
                <USD>6.38</USD>
            </total>
        </end_buyer>
        <contractual_amount>
            <transactions>
                <amount>6.00</amount>
                <currency>EUR</currency>
                <comment>Return 'Order reference' was billed by tracking event: Received by the carrier. 1 parcel
                    billed
                </comment>
            </transactions>
            <transactions>
                <amount>7.00</amount>
                <currency>USD</currency>
                <comment>Return 'Order reference' was billed by tracking event: Delivered to the retailer. 1 parcel
                    billed
                </comment>
            </transactions>
            <total>
                <GBP>10.89</GBP>
                <EUR>12.07</EUR>
                <USD>13.92</USD>
            </total>
        </contractual_amount>
        <approximate_invoice_amount>
            <GBP>5.89</GBP>
            <EUR>6.53</EUR>
            <USD>7.54</USD>
        </approximate_invoice_amount>
    </returns>
    <returns>
        <order_reference>Order reference</order_reference>
        <tracking>Tracking2</tracking>
        <external_id></external_id>
        <current_tracking_status>60</current_tracking_status>
        <date_added>1465398894</date_added>
        <end_buyer>
            <transactions>
                <amount>5.00</amount>
                <currency>GBP</currency>
                <comment>Return 'Order reference' was paid by customer.</comment>
            </transactions>
            <total>
                <GBP>5.00</GBP>
                <EUR>5.54</EUR>
                <USD>6.38</USD>
            </total>
        </end_buyer>
        <contractual_amount>
            <transactions>
                <amount>6.00</amount>
                <currency>EUR</currency>
                <comment>Return 'Order reference' was billed by tracking event: Received by the carrier. 1 parcel
                    billed
                </comment>
            </transactions>
            <transactions>
                <amount>7.00</amount>
                <currency>USD</currency>
                <comment>Return 'Order reference' was billed by tracking event: Delivered to the retailer. 1 parcel
                    billed
                </comment>
            </transactions>
            <total>
                <GBP>10.89</GBP>
                <EUR>12.07</EUR>
                <USD>13.92</USD>
            </total>
        </contractual_amount>
        <approximate_invoice_amount>
            <GBP>5.89</GBP>
            <EUR>6.53</EUR>
            <USD>7.54</USD>
        </approximate_invoice_amount>
    </returns>
</success>
        

Return not found:

{
    "error": {
        "code": "return_nx",
        "message": [
            "Return not found"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>return_nx</code>
    <message>Return not found</message>
</error>

Input data

tracking

You can provide a filter data in 2 formats: JSON, XML

JSON

{
    "tracking":
    {
        "code": "514500294005"
    }
}

XML

<tracking>
    <code>514500294005</code>
</tracking>

Output data

Response fields. Full tracking data.

Location

JSON response example:

{
   "success": {
      "track": [
         {
            "dt": "1488469413",
            "status": "10",
            "location": {
               "country": "CZ",
               "state": "ČR",
               "city": "Praha"
            }
         },
         {
            "dt": "1488482100",
            "status": "20",
            "location": {
               "country": "CZ",
               "state": "",
               "city": ""
            }
         },
         {
            "dt": "1488526560",
            "status": "30",
            "location": {
               "country": "CZ",
               "state": "",
               "city": ""
            }
         },
         {
            "dt": "1488561000",
            "status": "30",
            "location": {
               "country": "DE",
               "state": "Radefeld",
               "city": ""
            }
         },
         {
            "dt": "1488566460",
            "status": "30",
            "location": {
               "country": "DE",
               "state": "Radefeld",
               "city": ""
            }
         },
         {
            "dt": "1488603900",
            "status": "30",
            "location": {
               "country": "DE",
               "state": "Börnicke",
               "city": ""
            }
         },
         {
            "dt": "1488603960",
            "status": "40",
            "location": {
               "country": "DE",
               "state": "Großbeeren",
               "city": ""
            }
         },
         {
            "dt": "1488758400",
            "status": "50",
            "location": {
               "country": "DE",
               "state": "",
               "city": ""
            }
         },
         {
            "dt": "1488758400",
            "status": "60",
            "location": {
               "country": "GB",
               "state": "Selby",
               "city": "Selby"
            }
         }
      ],
      "pallet_number": "1000",
      "source_country": "CZ",
      "carrier_name": "DHL",
      "service_id": "23",
      "external_id": "999",
      "order_reference": "Order Reference"
   }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
   <track>
      <dt>1488469413</dt>
      <status>10</status>
      <location>
         <country>CZ</country>
         <state>ČR</state>
         <city>Praha</city>
      </location>
   </track>
   <track>
      <dt>1488482100</dt>
      <status>20</status>
      <location>
         <country>CZ</country>
         <state />
         <city />
      </location>
   </track>
   <track>
      <dt>1488526560</dt>
      <status>30</status>
      <location>
         <country>CZ</country>
         <state />
         <city />
      </location>
   </track>
   <track>
      <dt>1488561000</dt>
      <status>30</status>
      <location>
         <country>DE</country>
         <state>Radefeld</state>
         <city />
      </location>
   </track>
   <track>
      <dt>1488566460</dt>
      <status>30</status>
      <location>
         <country>DE</country>
         <state>Radefeld</state>
         <city />
      </location>
   </track>
   <track>
      <dt>1488603900</dt>
      <status>30</status>
      <location>
         <country>DE</country>
         <state>Börnicke</state>
         <city />
      </location>
   </track>
   <track>
      <dt>1488603960</dt>
      <status>40</status>
      <location>
         <country>DE</country>
         <state>Großbeeren</state>
         <city />
      </location>
   </track>
   <track>
      <dt>1488758400</dt>
      <status>50</status>
      <location>
         <country>DE</country>
         <state />
         <city />
      </location>
   </track>
   <track>
      <dt>1488758400</dt>
      <status>60</status>
      <location>
         <country>GB</country>
         <state>Selby</state>
         <city>Selby</city>
      </location>
   </track>
   <pallet_number>1000</pallet_number>
   <source_country>CZ</source_country>
   <carrier_name>DHL</carrier_name>
   <service_id>23</service_id>
   <external_id>999</external_id>
   <order_reference>Order Reference</order_reference>
</success>
        

Nothing found:

{
    "error": {
        "code": "empty",
        "message": [
            "Nothing found."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>empty</code>
    <message>Nothing found.</message>
</error>
                                

Input data

You can provide a filter data in 2 formats: JSON, XML

JSON

{
    "filter":
    {
        "date_from": "2024/11/20 06:46:57",
        "date_to": "2024/11/21 06:46:57"
    }
}

XML

<filter>
    <date_from>2024/11/20 06:46:57</date_from>
    <date_to>2024/11/21 06:46:57</date_to>
</filter>

Output data

Response fields.

Tracking data. Tracking events grouped by tracking numbers.

Events

Location

JSON response example:

{
   "success": {
      "tracking_data": [
         {
            "tracking_number": "00350559268102004358",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Uppsala"
                  }
               },
               {
                  "status": "30",
                  "dt": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Uppsala"
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102018270",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "30",
                  "dt": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Landvetter"
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102009469",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "30",
                  "dt": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Järfälla"
                  }
               }
            ]
         },
         {
            "tracking_number": "512902293586",
            "pallet_number": "",
            "source_country": "RO",
            "carrier_name": "DHL",
            "service_id": "31",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087940",
                  "location": {
                     "country": "RO",
                     "state": "",
                     "city": ""
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102026343",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Stockholm"
                  }
               },
               {
                  "status": "30",
                  "dt": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Stockholm"
                  }
               }
            ]
         }
      ],
      "total_events_count": 7,
      "current_page": 1,
      "total_pages_count": 1,
      "count_per_page": 20000
   }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
   <tracking_data>
      <tracking_number>00350559268102004358</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087880</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Uppsala</city>
         </location>
      </events>
      <events>
         <status>30</status>
         <dt>1475087880</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Uppsala</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102018270</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>30</status>
         <dt>1475087880</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Landvetter</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102009469</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>30</status>
         <dt>1475087940</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Järfälla</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>512902293586</tracking_number>
      <pallet_number />
      <source_country>RO</source_country>
      <carrier_name>DHL</carrier_name>
      <service_id>31</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087940</dt>
         <location>
            <country>RO</country>
            <state />
            <city />
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102026343</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087940</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Stockholm</city>
         </location>
      </events>
      <events>
         <status>30</status>
         <dt>1475087940</dt>
         <location>
            <country>SE</country>
            <state />
            <city>Stockholm</city>
         </location>
      </events>
   </tracking_data>
   <total_events_count>7</total_events_count>
   <current_page>1</current_page>
   <total_pages_count>1</total_pages_count>
   <count_per_page>20000</count_per_page>
</success>
        

Nothing found:

{
    "error": {
        "code": "empty",
        "message": [
            "Nothing found."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>empty</code>
    <message>Nothing found.</message>
</error>
                                

Input data

You can provide a filter data in 2 formats: JSON, XML

JSON

{
    "filter":
    {
        "date_from": "2024/11/20 06:46:57",
        "date_to": "2024/11/21 06:46:57"
    }
}

XML

<filter>
    <date_from>2024/11/20 06:46:57</date_from>
    <date_to>2024/11/21 06:46:57</date_to>
</filter>

Output data

Response fields.

Tracking data. Tracking events grouped by tracking numbers.

Events

Location

JSON response example:

{
   "success": {
      "tracking_data": [
         {
            "tracking_number": "00350559268102004358",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087880",
                  "date_added": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Uppsala"
                  }
               },
               {
                  "status": "30",
                  "dt": "1475087880",
                  "date_added": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Uppsala"
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102018270",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "30",
                  "dt": "1475087880",
                  "date_added": "1475087880",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Landvetter"
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102009469",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "30",
                  "dt": "1475087940",
                  "date_added": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Järfälla"
                  }
               }
            ]
         },
         {
            "tracking_number": "512902293586",
            "pallet_number": "",
            "source_country": "RO",
            "carrier_name": "DHL",
            "service_id": "31",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087940",
                  "date_added": "1475087940",
                  "location": {
                     "country": "RO",
                     "state": "",
                     "city": ""
                  }
               }
            ]
         },
         {
            "tracking_number": "00350559268102026343",
            "pallet_number": "",
            "source_country": "SE",
            "carrier_name": "MyPack",
            "service_id": "40",
            "external_id": "",
            "order_reference": "Order Reference",
            "events": [
               {
                  "status": "20",
                  "dt": "1475087940",
                  "date_added": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Stockholm"
                  }
               },
               {
                  "status": "30",
                  "dt": "1475087940",
                  "date_added": "1475087940",
                  "location": {
                     "country": "SE",
                     "state": "",
                     "city": "Stockholm"
                  }
               }
            ]
         }
      ],
      "total_events_count": 7,
      "current_page": 1,
      "total_pages_count": 1,
      "count_per_page": 20000
   }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
   <tracking_data>
      <tracking_number>00350559268102004358</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087880</dt>
         <date_added>1475087880</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Uppsala</city>
         </location>
      </events>
      <events>
         <status>30</status>
         <dt>1475087880</dt>
         <date_added>1475087880</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Uppsala</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102018270</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>30</status>
         <dt>1475087880</dt>
         <date_added>1475087880</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Landvetter</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102009469</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>30</status>
         <dt>1475087940</dt>
         <date_added>1475087940</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Järfälla</city>
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>512902293586</tracking_number>
      <pallet_number />
      <source_country>RO</source_country>
      <carrier_name>DHL</carrier_name>
      <service_id>31</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087940</dt>
         <date_added>1475087940</date_added>
         <location>
            <country>RO</country>
            <state />
            <city />
         </location>
      </events>
   </tracking_data>
   <tracking_data>
      <tracking_number>00350559268102026343</tracking_number>
      <pallet_number />
      <source_country>SE</source_country>
      <carrier_name>MyPack</carrier_name>
      <service_id>40</service_id>
      <external_id />
      <order_reference>Order Reference</order_reference>
      <events>
         <status>20</status>
         <dt>1475087940</dt>
         <date_added>1475087940</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Stockholm</city>
         </location>
      </events>
      <events>
         <status>30</status>
         <dt>1475087940</dt>
         <date_added>1475087940</date_added>
         <location>
            <country>SE</country>
            <state />
            <city>Stockholm</city>
         </location>
      </events>
   </tracking_data>
   <total_events_count>7</total_events_count>
   <current_page>1</current_page>
   <total_pages_count>1</total_pages_count>
   <count_per_page>20000</count_per_page>
</success>
        

Nothing found:

{
    "error": {
        "code": "empty",
        "message": [
            "Nothing found."
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>empty</code>
    <message>Nothing found.</message>
</error>
                                

Input data

Request data (* required)

tracking_status

Location

You can provide a return data in 2 formats: JSON, XML

JSON

{
    "tracking_status":
    {
        "tracking": "540324195682",
        "date": 1475087880,
        "status": 30,
        "description": "Test description",
        "carrier_status": "123ABC",
        "location":
        {
            "country": "GB",
            "state": "Greater London",
            "city": "London"
        }
    }
}

XML

<tracking_status>
    <tracking>540324195682</tracking>
    <date>1475087880</date>
    <status>30</status>
    <description>Test description</description>
    <carrier_status>123ABC</carrier_status>
    <location>
        <country>GB</country>
        <state>Greater London</state>
        <city>London</city>
    </location>
</tracking_status>

Output data

Return update successfully:

{
    "success":
    {
        "code": "success",
        "message": [
            "Return 540324195682 update successfully"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <code>success</code>
    <message>Return 540324195682 update successfully</message>
</success>

Incorrect return data:

{
    "error": {
        "code": "status_incorrect",
        "message": [
            "Status incorrect"
        ]
    }
}
        

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>status_incorrect</code>
    <message>Status incorrect</message>
</error>

JSON is not valid:

{
    "error": {
        "code": "json_invalid",
        "message": [
            "JSON is not valid"
        ]
    }
}
        

XML is not valid:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>xml_invalid</code>
    <message>XML is not valid</message>
</error>

Input data

You can receive a response in 2 formats: JSON, XML

JSON

XML

Output data

Response fields.

JSON SUCCESS response example:

{
    "success": {
        "date": "1474467743"
    }
}
        

XML SUCCESS response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <date>
        1474467743
    </date>
</success>
        

JSON UNAVAILABLE response example:

{
   "error": {
      "code": "internal",
      "message": [
         "Internal server error."
      ]
   }
}
        

XML UNAVAILABLE response example:

<?xml version="1.0" encoding="UTF-8"?>
<error>
   <code>internal</code>
   <message>Internal server error.</message>
</error>
        

Input data

Request data (* required)

You can provide a request data in 2 formats: JSON, XML

JSON

{
    "request": {
        "country":"AU"
    }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<request>
   <country>AU</country>
</request>

Output data

Response data

success

services

coverage

countries

states

JSON response example:

{
   "success": {
      "services": [
         {
            "carrier": "Australia Post",
            "service_id": "114",
            "service_name": "Australia Post",
            "service_type": "drop_off",
            "coverage": {
               "countries": [
                  {
                     "country": "AU",
                     "states": "full"
                  }
               ]
            }
         },
         {
            "carrier": "parcel_point",
            "service_id": "66",
            "service_name": "ParcelPoint Home Collection",
            "service_type": "home_collection",
            "coverage": {
               "countries": [
                  {
                     "country": "AU",
                     "states": [
                        {
                           "state": "act",
                           "cities": "full",
                           "suburbs": [
                              "acton",
                              "ainslie",
                              "amaroo"
                           ]
                        },
                        {
                           "state": "nsw",
                           "cities": "full",
                           "suburbs": "full"
                        },
                        {
                           "state": "nt",
                           "cities": "full",
                           "suburbs": "full"
                        }
                     ]
                  }
               ]
            }
         }
      ]
   }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
   <services>
      <carrier>Australia Post</carrier>
      <service_id>114</service_id>
      <service_name>Australia Post</service_name>
      <service_type>drop_off</service_type>
      <coverage>
         <countries>
            <country>AU</country>
            <states>full</states>
         </countries>
      </coverage>
   </services>
   <services>
      <carrier>parcel_point</carrier>
      <service_id>66</service_id>
      <service_name>ParcelPoint Home Collection</service_name>
      <service_type>home_collection</service_type>
      <coverage>
         <countries>
            <country>AU</country>
            <states>
               <state>act</state>
               <cities>full</cities>
               <suburbs>acton</suburbs>
               <suburbs>ainslie</suburbs>
               <suburbs>amaroo</suburbs>
            </states>
            <states>
               <state>nsw</state>
               <cities>full</cities>
               <suburbs>full</suburbs>
            </states>
            <states>
               <state>nt</state>
               <cities>full</cities>
               <suburbs>full</suburbs>
            </states>
         </countries>
      </coverage>
   </services>
</success>
                                

Nothing found:

{
   "error": {
      "code": "service_nx",
      "message": [
         "No services were found by given address"
      ]
   }
}
                                

<?xml version="1.0" encoding="UTF-8"?>
<error>
   <code>service_nx</code>
   <message>No services were found by given address</message>
</error>
                                

Input data

Request data (* required)

Address info

Coordinates

You can provide a request data in 2 formats: JSON, XML

JSON

{
    "request": {
        "services": [
            1,
            2
        ],
        "address": {
            "country": "CA",
            "state": "ON",
            "zip": "M6H 2X5",
            "city": "Toronto",
            "addr1": "926 Dovercourt Rd",
            "addr2": ""
        },
        "coordinates": {
            "lat": "43.6657253",
            "lng": "-79.4313081"
        },
        "radius": "10"
    }
}

XML

<request>
    <services>1</services>
    <services>2</services>
    <address>
        <country>CA</country>
        <state>ON</state>
        <zip>M6H 2X5</zip>
        <city>Toronto</city>
        <addr1>926 Dovercourt Rd</addr1>
        <addr2></addr2>
    </address>
    <coordinates>
        <lat>43.6657253</lat>
        <lng>-79.4313081</lng>
    </coordinates>
    <radius>10</radius>
</request>

Output data

Response data

success

carriers

services

points

address_detail

detail_hours

JSON response example:

{
    "success": {
        "carriers": [
            {
                "id": 4,
                "name": "Correos",
                "services": [
                    {
                        "id": 13,
                        "name": "Correos Drop Off",
                        "points": [
                            {
                                "id": "123ABC",
                                "title": "BARCELONA SUC 23. LES CORTS",
                                "address_detail": {
                                    "country": "ES",
                                    "state": "",
                                    "zip": "08028",
                                    "city": "BARCELONA",
                                    "addr1": "AV. MADRID 106",
                                    "addr2": ""
                                },
                                "hours": false,
                                "detail_hours": false,
                                "lat": "41.37881",
                                "lng": "2.1280565"
                            }
                        ]
                    }
                ]
            },
            {
                "id": 21,
                "name": "Hermes Europe",
                "services": [
                    {
                        "id": 48,
                        "name": "Hermes Parcel Shop",
                        "points": [
                            {
                                "id": "124ABC",
                                "title": "ELECTRODOMESTICOS PEINADO",
                                "address_detail": {
                                    "country": "ES",
                                    "state": "",
                                    "zip": "08028",
                                    "city": "BARCELONA",
                                    "addr1": "CL JOAN GUELL",
                                    "addr2": ""
                                },
                                "hours": "monday-saturday 10:00-14:00 monday-friday 17:00-20:30",
                                "detail_hours": {
                                    "mo": [
                                        "10:00-14:00",
                                        "17:00-20:30"
                                    ],
                                    "tu": [
                                        "10:00-14:00",
                                        "17:00-20:30"
                                    ],
                                    "we": [
                                        "10:00-14:00",
                                        "17:00-20:30"
                                    ],
                                    "th": [
                                        "10:00-14:00",
                                        "17:00-20:30"
                                    ],
                                    "fr": [
                                        "10:00-14:00",
                                        "17:00-20:30"
                                    ],
                                    "sa": [
                                        "10:00-14:00"
                                    ],
                                    "su": false
                                },
                                "lat": 41.382355,
                                "lng": 2.131578
                            },
                            {
                                "id": "125ABC",
                                "title": "BITPHONE",
                                "address_detail": {
                                    "country": "ES",
                                    "state": "",
                                    "zip": "08028",
                                    "city": "BARCELONA",
                                    "addr1": "CL GALILEO",
                                    "addr2": ""
                                },
                                "hours": "monday-friday 09:00-21:00 saturday 09:00-17:00",
                                "detail_hours": {
                                    "mo": [
                                        "09:00-21:00"
                                    ],
                                    "tu": [
                                        "09:00-21:00"
                                    ],
                                    "we": [
                                        "09:00-21:00"
                                    ],
                                    "th": [
                                        "09:00-21:00"
                                    ],
                                    "fr": [
                                        "09:00-21:00"
                                    ],
                                    "sa": [
                                        "09:00-17:00"
                                    ],
                                    "su": false
                                },
                                "lat": 41.3766,
                                "lng": 2.1356463
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
        

XML response example:

<?xml version="1.0" encoding="UTF-8"?>
<success>
    <carriers>
        <id>4</id>
        <name>Correos</name>
        <services>
            <id>13</id>
            <name>Correos Drop Off</name>
            <points>
                <id>123ABC</id>
                <title>BARCELONA SUC 23. LES CORTS</title>
                <address_detail>
                    <country>ES</country>
                    <state></state>
                    <zip>08028</zip>
                    <city>BARCELONA</city>
                    <addr1>AV. MADRID 106</addr1>
                    <addr2></addr2>
                </address_detail>
                <hours></hours>
                <detail_hours></detail_hours>
                <lat>41.37881</lat>
                <lng>2.1280565</lng>
            </points>
        </services>
    </carriers>
    <carriers>
        <id>21</id>
        <name>Hermes Europe</name>
        <services>
            <id>48</id>
            <name>Hermes Parcel Shop</name>
            <points>
                <id>124ABC</id>
                <title>ELECTRODOMESTICOS PEINADO</title>
                <address_detail>
                    <country>ES</country>
                    <state></state>
                    <zip>08028</zip>
                    <city>BARCELONA</city>
                    <addr1>CL JOAN GUELL</addr1>
                    <addr2></addr2>
                </address_detail>
                <hours>monday-saturday 10:00-14:00 monday-friday 17:00-20:30</hours>
                <detail_hours>
                    <mo>10:00-14:00</mo>
                    <mo>17:00-20:30</mo>
                    <tu>10:00-14:00</tu>
                    <tu>17:00-20:30</tu>
                    <we>10:00-14:00</we>
                    <we>17:00-20:30</we>
                    <th>10:00-14:00</th>
                    <th>17:00-20:30</th>
                    <fr>10:00-14:00</fr>
                    <fr>17:00-20:30</fr>
                    <sa>10:00-14:00</sa>
                    <su></su>
                </detail_hours>
                <lat>41.382355</lat>
                <lng>2.131578</lng>
            </points>
            <points>
                <id>125ABC</id>
                <title>BITPHONE</title>
                <address_detail>
                    <country>ES</country>
                    <state></state>
                    <zip>08028</zip>
                    <city>BARCELONA</city>
                    <addr1>CL GALILEO</addr1>
                    <addr2></addr2>
                </address_detail>
                <hours>monday-friday 09:00-21:00 saturday 09:00-17:00</hours>
                <detail_hours>
                    <mo>09:00-21:00</mo>
                    <tu>09:00-21:00</tu>
                    <we>09:00-21:00</we>
                    <th>09:00-21:00</th>
                    <fr>09:00-21:00</fr>
                    <sa>09:00-17:00</sa>
                    <su></su>
                </detail_hours>
                <lat>41.3766</lat>
                <lng>2.1356463</lng>
            </points>
        </services>
    </carriers>
</success>
        

Nothing found:

{
    "error": {
        "code": "carrier_empty",
        "message": [
            "Missing required field 'address->country'."
        ]
    }
}
                                

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <code>carrier_empty</code>
    <message>Missing required field 'address->country'.</message>
</error>
                                

Tracking status codes.

Virtual tracking status codes.

Returns events status codes.

"Create order" request example.

<?php

$login = 'demo_api';
$api_key = 'api_key';

$order = array (
    'order_reference' => '1000000000000',
    'order_date' => '10/20/2015',
    'rma' => '12345',
    'contact_name' => 'John Smith',
    'company_name' => '',
    'addr1' => '6 Semaphore Close Mount Pleasant',
    'addr2' => '',
    'addr3' => 'Christchurch',
    'zip' => '8081',
    'state' => 'qwe',
    'country' => 'NZ',
    'phone' => '+102030405060',
    'email' => 'john.smith@googlemail.com',
    'currency_code' => 'AUD',
    'export_awb' => '32153454GB',
    'export_carrier_name' => 'USPS',
    'item' => array (
        array (
            'sku_code' => 'QWE123',
            'sku_desc' => 'Black Sculpting & Smoothing Shapewear Body Suit-EUR 38 (M)',
            'quantity' => '5',
            'price' => '100',
            'weight' => '1',
            'length' => '2',
            'width' => '3',
            'height' => '4',
            'dimensions_uom' => 'mm',
            'hs_code' => '',
            'country_code' => 'GB',
            'img_path' => '',
        ),
        array (
            'sku_code' => 'QWE456',
            'sku_desc' => 'Black Halterneck Corset',
            'quantity' => '10',
            'price' => '200',
            'weight' => '0.86',
            'length' => '0',
            'width' => '0',
            'height' => '0',
            'dimensions_uom' => 'mm',
            'hs_code' => '',
            'country_code' => 'GB',
            'img_path' => '',
        ),
    ),
);

// Production API entry point
$entryPoint = 'https://intelligentreturns.net/api/';
// Test API entry point
$entryPoint = 'http://test.intelligentreturns.net/api/';
$method = 'orders/create/';
$format = 'json';

$post = array(
    'login' => $login,
    'api_key' => $api_key,
    'request' => json_encode(array('order' => $order))
);

$ch = curl_init($entryPoint . $method . $format);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post, '', '&'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
if ($result === false) {
    // cURL error
    die(curl_error($ch));
}
curl_close($ch);

$response = json_decode($result, true);

if ($response === null) {
    // Not json response
    die($result);
}

if (!empty($response['success'])) {
    // Order created
    $order_id = $response['success']['order_id'];
    die('Ok. Order ID: '. $order_id);
} elseif (!empty($response['error'])) {
    // Order was not created
    $error_code = $response['error']['code'];
    $messages = $response['error']['message'];
    die('Error code: ' . $error_code. '. Messages: '.implode("\r\n", $messages));
}

die('Unknown response format.');

                                

"Check availability" method example.

<?php
// Production API entry point
$entryPoint = 'https://intelligentreturns.net/api/';
// Test API entry point
$entryPoint = 'http://test.intelligentreturns.net/api/';
$method = 'check/available/';
$format = 'json';

$post = array(
   'request' => ''
);

$ch = curl_init($entryPoint . $method . $format);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post, '', '&'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$result = curl_exec($ch);
if ($result === false) {
    // cURL error
    die(curl_error($ch));
}
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($http_code != 200) {
    die('Temporary unavailable');
}

$response = json_decode($result, true);

if ($response === null) {
    // Not json response, check your request
    die($result);
}

if (!empty($response['success'])) {
    if(!empty($response['success']['date'])) {
        die('Ok. Service is available.');
    } else {
        // Check the online documentation https://intelligentreturns.net/api/
        var_dump($response);
        die('Unknown response format.');
    }
} elseif (!empty($response['error'])) {
    // Temporary unavailable
    $error_code = $response['error']['code'];
    $messages = $response['error']['message'];
    die('Error code: ' . $error_code. '. Messages: '.implode("\r\n", $messages));
}
// Check the online documentation https://intelligentreturns.net/api/
var_dump($response);
die('Unknown response format.');