Returns

POST/xml/orders/returns/

Specific Order(s)

This endpoint allows you to retrieve returns data for specific orders, if present. See the code examples for how to send the request to the FCP API.

Request Elements

Name
ReturnsRequest
Type
XML
Required
required
Description
The root XML element contains your API credentials and a list of return orders to be submitted.
Name
MerchantId
Type
integer
Required
required
Description
The unique ID number for your Fulﬁllment Control Panel account.
Name
MerchantToken
Type
string
Required
required
Description
Security token to protect against unauthorized orders.
Name
ReturnsList
Type
XML
Required
required
Description
Contains all returns elements to be submitted.
Name
Return
Type
XML
Required
required
Description
This element contains all the detail elements for each return order.
Name
OrderNumber
Type
string
Required
required
Description
Your identifying reference number for the order.

Response Element Details

For each Item the Good element denotes undamaged product returned to available inventory. The Hurt element represents damaged or unusable product.

Example Request / Payload

Request

<?xml version="1.0" encoding="UTF-8"?>
<ReturnsRequest>
    <MerchantId>{{CLIENT_ID}}</MerchantId>
    <MerchantToken>{{CLIENT_TOKEN}}</MerchantToken>
    <ReturnsList>
        <Return>
            <OrderNumber>#765-10002</OrderNumber>
        </Return>
        <Return>
            <OrderNumber>105-7078577-8544206</OrderNumber>
        </Return>
    </ReturnsList>
</ReturnsRequest>

Example Response

Response

<?xml version="1.0" encoding="UTF-8"?>
<ReturnsResponse>
    <Status>Success</Status>
    <Description/>
    <ReturnsList>
        <Return>
            <ReturnId>300204</ReturnId>
            <ReturnDate>2024-04-08 17:49:25</ReturnDate>
            <OrderNumber>#765-10002</OrderNumber>
            <OrderReference></OrderReference>
            <OrderConfirmation>15970118</OrderConfirmation>
            <Comments>Refund, corner of seal under cap is slightly peeled up, returning as hurt, DB</Comments>
            <ReturnItemsList>
                <Item>
                    <Sku>200000111102</Sku>
                    <Good>0</Good>
                    <Hurt>1</Hurt>
                    <Comments>15970118</Comments>
                </Item>
            </ReturnItemsList>
        </Return>
        <Return>
            <ReturnId/>
            <ReturnDate/>
            <OrderNumber>105-7078577-8544206</OrderNumber>
            <OrderReference></OrderReference>
            <OrderConfirmation>N/A</OrderConfirmation>
            <Comments/>
            <ReturnItemList/>
        </Return>
    </ReturnsList>
</ReturnsResponse>

POST/xml/orders/returns/list/

Date Range

This endpoint allows you to retrieve return orders processed within a specific date range. See the code examples for how to send the request to the FCP API.

Request Elements

Name
InventoryRequest
Type
XML
Required
required
Description
The root XML element contains your API credentials and a list of inventory items to be submitted.
Name
MerchantId
Type
integer
Required
required
Description
The unique ID number for your Fulﬁllment Control Panel account.
Name
MerchantToken
Type
string
Required
required
Description
Security token to protect against unauthorized orders.
Name
StartDate
Type
date
Required
required
Description
The start date for the date range filter (YYYY-MM-DD).
Name
EndDate
Type
date
Required
required
Description
The end date for the date range filter (YYYY-MM-DD).

Date range cannot exceed 31 days.

Response Element Details

For each Item the Good element denotes undamaged product returned to available inventory. The Hurt element represents damaged or unusable product.

Example Request / Payload

Request

<?xml version="1.0" encoding="UTF-8"?>
<ReturnsRequest>
    <MerchantId>{{CLIENT_ID}}</MerchantId>
    <MerchantName>{{CLIENT_NAME}}</MerchantName>
    <MerchantToken>{{CLIENT_TOKEN}}</MerchantToken>
    <StartDate>2024-04-01</StartDate>
    <EndDate>2024-04-15</EndDate>
</ReturnsRequest>

Example Response

Request

<?xml version="1.0" encoding="UTF-8"?>
<ReturnsResponse>
    <Status>Success</Status>
    <Description/>
    <ReturnsList>
        <Return>
            <ReturnId>300204</ReturnId>
            <ReturnDate>2024-04-08 17:49:25</ReturnDate>
            <OrderNumber>#765-10002</OrderNumber>
            <OrderReference></OrderReference>
            <OrderConfirmation>15970118</OrderConfirmation>
            <Comments>Refund, corner of seal under cap is slightly peeled up, returning as hurt, DB</Comments>
            <ReturnItemsList>
                <Item>
                    <Sku>200000111102</Sku>
                    <Good>0</Good>
                    <Hurt>1</Hurt>
                    <Comments>15970118</Comments>
                </Item>
            </ReturnItemsList>
        </Return>
    </ReturnsList>
</ReturnsResponse>