getCollectionFormHistory

Rate (requests per second)	Burst
80	100

Request

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body Params application/json

The request schema to get query collections form history API .

clientReferenceDetails

array[object (ClientReferenceDetail) {2}]

optional

Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail

clientReferenceType

enum<string>

required

Client Reference type.

Allowed values:

IntegratorShipperIdIntegratorMerchantId

clientReferenceId

string

required

The Client Reference Id.

maxResults

integer

optional

max Number of Results for query .

carrierId

string

optional

The carrier identifier for the offering, provided by the carrier.

shipFromAddress

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"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"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

dateRange

object (DateRange)

optional

The time range within which something (for example, a delivery) will occur.

earliest

string <date-time>

required

Date timestamp

latest

string <date-time>

required

Date timestamp

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 samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The Response for the GetCollectionFormHistoryResponse operation.

collectionFormsHistoryRecordList

array[object (CollectionFormsHistoryRecord) {5}]

optional

A list of CollectionFormsHistoryRecord

carrierName

string

optional

The carrier name for the offering.

creationDate

string <dateTime>

optional

Creation Time for this account.

generationStatus

enum<string>

optional

Generation Status.

Allowed values:

CompletedInProgress

collectionFormId

string

optional

Collection Form Id for Reprint .

shipFromAddress

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"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"}

lastRefreshedDate

string

optional

Last Refereshed Date of collection

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