createUploadDestinationForResource

POST

/uploads/2020-11-01/uploadDestinations/{resource}

uploads

Last modified:2024-11-28 08:42:10

Maintainer:Not configured

Creates an upload destination, returning the information required to upload a file to the destination and to programmatically access the file.

Usage Plan:

Rate (requests per second)	Burst
10	10

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 than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

resource

string

required

The resource for the upload destination that you are creating. For example, if you are creating an upload destination for the createLegalDisclosure operation of the Messaging API, the {resource} would be /messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure, and the entire path would be /uploads/2020-11-01/uploadDestinations/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure. If you are creating an upload destination for an Aplus content document, the {resource} would be aplus/2020-11-01/contentDocuments and the path would be /uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments.

Query Params

marketplaceIds

array[string]

required

A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified.

<= 1 items

contentMD5

string

required

An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.

contentType

string

optional

The content type of the file to be uploaded.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/uploads/2020-11-01/uploadDestinations/?marketplaceIds&contentMD5'

Responses

🟢201Created

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 schema for the createUploadDestination operation.

payload

object (UploadDestination)

optional

Information about an upload destination.

uploadDestinationId

string

optional

The unique identifier for the upload destination.

url

string

optional

The URL for the upload destination.

headers

object

optional

The headers to include in the upload request.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "uploadDestinationId": "5d4e42b5-1d6e-44e8-a89c-2abfca0625bb",
        "url": "https://s3.amazonaws.com/buyer-seller-messaging-test-draft-attachment-namarketplace/%2F067/5d4e42b5-1d6e-44e8-a89c-2abfca0625bb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190701T214102Z&X-Amz-SignedHeaders=content-md5%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=900&X-Amz-Credential=AKIAW5VUA47ENEOYT7RC%2F20190701%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d4f85c5f1a32a788a8d54e3f00a2a08af45be5b83551cdd81c82ae353dfcdfd4",
        "headers": {
            "Content-MD5": "5d41402abc4b2a76b9719d911017c592",
            "x-amz-server-side-encryption": "aws:kms"
        }
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

createRestrictedDataToken

getSubscription