getCollectionFormHistory

Pending

PUT

/shipping/v2/collectionForms/history

Last modified:2025-06-25 09:22:56

Maintainer:Not configured

This API Call to get the history of the previously generated collection forms.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Header Params

Body Params application/json

Example

{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "maxResults": 0,
    "carrierId": "string",
    "shipFromAddress": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "dateRange": {
        "earliest": "2019-08-24T14:15:22Z",
        "latest": "2019-08-24T14:15:22Z"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/collectionForms/history' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientReferenceDetails": [
        {
            "clientReferenceType": "IntegratorShipperId",
            "clientReferenceId": "string"
        }
    ],
    "maxResults": 0,
    "carrierId": "string",
    "shipFromAddress": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "dateRange": {
        "earliest": "2019-08-24T14:15:22Z",
        "latest": "2019-08-24T14:15:22Z"
    }
}'

Responses

🟢200OK

application/json

Success.

Headers

Body

Example

{
    "collectionFormsHistoryRecordList": [
        {
            "carrierName": "USPS",
            "creationDate": 1650163712052,
            "generationStatus": "COMPLETED",
            "collectionFormId": "2c631e32-2538-3431-889e-008b6f5a6f11",
            "shipFromAddress": "<**-redacted-**>"
        }
    ],
    "lastRefreshedDate": "April 17 2022 06:20 PM PDT"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-06-25 09:22:56

generateCollectionForm

getUnmanifestedShipments