Reshipments

The Reshipments resource allows you to reship one or more returned packages at a time from a BoxC facility. When a reshipment is created the status of all included returns will change to "Reshipping". Only returns with the following status can be reshipped: Processed, Verifying, and Verified. If reshipping more than one return at a time then you must wait for a facility operator to provide an estimated_reship_fee. If reshipping one return then the estimate will be instantaneous. In both cases you must approve the estimate before the reshipment is sent and your account is charged.

Status

When a reshipment is created its status is set to "Pending" by default. It will remain that way until the estimated_reship_fee is populated by the system or facility operator. Afterwards, you have the option to approve or decline the amount by updating the status accordingly. If "Declined", it will not be reshipped. If "Approved" it will be reshipped, tracking information will be made available, and a final reship_fee will be provided. Reshipments with the status "Approved" cannot be deleted.

Important: Reshipments that are "Pending" or "Declined" longer than 15 days will be deleted by the system.
Note: The final reshipping fee may differ from the estimated reshipping fee.

Actions

GET /reshipments Retrieves a paginated list of reshipments
GET /reshipments/{id} Retrieves a reshipment
POST /reshipments Creates a reshipment
PUT /reshipments/{id} Updates a reshipment
DELETE /reshipments/{id} Deletes a reshipment

Properties

contents

{"contents": "Leggings"}

String - A description of the contents in this reshipment for Customs requirements. Required. Max length: 60.
created

{"created": "2016-09-02 12:00:15"}

Datetime - The UTC date and time the reshipment was created. Set by the system.
estimated_reship_fee

{"estimated_reship_fee": 14.20}

Decimal - An estimated price in USD for this reshipment including the cost of the label and packaging material. Set by the system. Default: 0
id

{"id": 13489}

Integer - The unique ID for this reshipment. Set by the system.
reship_fee

{"reship_fee": 14.37}

Decimal - The fee in USD for this reshipment including the cost of the label and packaging material. Set by the system. Default: 0
returns 

{
    "returns": [
        12001,
        12002
    ]
}

Array - A list of return IDs included in this reshipment. If searching for reshipments then the total number of returns will be shown instead. This property is immutable.
service

{"service": "USPS"}

String - The carrier used for this reshipment. Set by the system. Default: null
status

{"status": "Approved"}

String - The status of this reshipment. Can be one of:
  • Pending
  • Declined
  • Approved
to 

{
    "to": {
        "company_name": null,
        "name": "John Smith",
        "phone": "555-123-4562",
        "street1": "108 N WESTGATE WAY",
        "street2": null,
        "city": "WYLIE",
        "province": "TX",
        "postal_code": "75098",
        "country": "US"
    }
}

The recipient / consignee's shipping address. This property is immutable.

company_name: String(40) - The company name. Not required.
name: String(40) - The recipient's name. Required.
phone: String(20) - The recipient's phone number. Not required.
street1: String(40) - The recipient's street address. Required.
street2: String(40) - Additional space for the recipient's street address. Not required.
city: String(40) - The recipient's city. Required.
province: String(40) - The recipient's province or state. Conditional.
postal_code: String(10) - The recipient's postal code or ZIP Code. Conditional.
country: String(2) - The recipient's country in ISO 3166-1 alpha-2 format. Required.
tracking_number

{"tracking_number": "9261299997140101431920"}

String - The tracking number for this reshipment. Set by the system. Default: null
value

{"value": 29.95}

Decimal - The total value of the contents in this reshipment for Customs requirements. Required.
weight

{"weight": 0.791}

Decimal - The measured actual weight of this reshipment in KG. Set by the system. Default: 0
GET
/reshipments/{id}
Retrieves a reshipment
request
GET /reshipments/1001 

        

        

        

            
response

            
HTTP/1.1 200 OK

                        
{
    "reshipment": {
        "contents": "Leggings",
        "created": "2016-06-30 12:34:55",
        "estimated_reship_fee": 14.2,
        "id": 1001,
        "reship_fee": 14.37,
        "returns": [
            12001,
            12002,
            12003
        ],
        "service": "USPS",
        "status": "Approved",
        "to": {
            "company_name": "Big Company, LLC",
            "name": "John Doe",
            "phone": null,
            "street1": "5200 Harry Hines Blvd",
            "street2": null,
            "city": "Dallas",
            "province": "TX",
            "postal_code": "75235",
            "country": "US"
        },
        "tracking_number": "9261299997140101431920",
        "value": 29.95,
        "weight": 0.895
    }
}

        

    






    

        
POST

        
/reshipments

    

    

        Creates a reshipment
    

    

        

            
request

            POST /reshipments
                        
{
    "reshipment": {
        "contents": "Leggings",
        "returns": [
            12001,
            12002,
            12003
        ],
        "to": {
            "company_name": "Big Company, LLC",
            "name": "John Doe",
            "phone": null,
            "street1": "5200 Harry Hines Blvd",
            "street2": null,
            "city": "Dallas",
            "province": "TX",
            "postal_code": "75235",
            "country": "US"
        },
        "value": 29.95
    }
}

        

        

        

            
response

            
HTTP/1.1 201 Created

                        
{
    "reshipment": {
        "contents": "Leggings",
        "created": "2016-06-30 12:34:55",
        "estimated_reship_fee": 0,
        "id": 1001,
        "reship_fee": 0,
        "returns": [
            12001,
            12002,
            12003
        ],
        "service": null,
        "status": "Pending",
        "tracking_number": null,
        "value": 29.95,
        "weight": 0
    }
}

        

    






    

        
PUT

        
/reshipments/{id}

    

    

        Updates a reshipment
    

    

        

            
request

            PUT /reshipments/1001
                        
{
    "reshipment": {
        "status": "Approved"
    }
}

        

        

        

            
response

            
HTTP/1.1 200 OK

                        
{
    "reshipment": {
        "contents": "Leggings",
        "created": "2016-06-30 12:34:55",
        "estimated_reship_fee": 14.2,
        "id": 1001,
        "reship_fee": 0,
        "returns": [
            12001,
            12002,
            12003
        ],
        "service": null,
        "status": "Approved",
        "to": {
            "company_name": "Big Company, LLC",
            "name": "John Doe",
            "phone": null,
            "street1": "5200 Harry Hines Blvd",
            "street2": null,
            "city": "Dallas",
            "province": "TX",
            "postal_code": "75235",
            "country": "US"
        },
        "tracking_number": null,
        "value": 29.95,
        "weight": 0.895
    }
}

        

    






    

        
DELETE

        
/reshipments/{id}

    

    

        Deletes a reshipment
    

    

        

            
request

            DELETE /reshipments/1001
            

        

        

        

            
response

            
HTTP/1.1 20O OK