Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation

Deprecation Notice:

Amazon Marketplace Web Service (MWS) will no longer be available after December 31, 2023. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.

Amazon MWS Documentation

CreateScheduledPackage

Description

Calling the CreateScheduledPackage operation does the following:

  • Schedules an Amazon Easy Ship package pickup slot. This is a window of time when the seller can expect their package to be picked up for delivery to the buyer.
  • Marks the Amazon Easy Ship order status as WaitingForPickup. You can check the status of Amazon Easy Ship orders by calling the ListOrders operation of the Orders API section and examining the EasyShipShipmentStatus response element.
  • Generates a shipping label and an invoice. Calling CreateScheduledPackage also generates a warranty document if you specify a SerialNumber value. To get these documents, see How to get invoice, shipping label, and warranty documents

Availability

This operation is available only in the India marketplace.

Throttling

Maximum request quota Restore rate
15 requests 15 requests every minute
For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Name Description Required Values
AmazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. Yes Type: xs:string
MarketplaceId The marketplace that the seller is selling in. Yes Type: xs:string
PackageRequestDetails The package information required for creating the scheduled package Yes Type: PackageRequestDetails

Response elements

Name Description
ScheduledPackage Information about the scheduled package.

Type: Package

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

https://mws.amazonservices.in/EasyShip/2018-09-01
  ?AWSAccessKeyId=0PB842EXAMPLE7N4ZTR2
  &Action=CreateScheduledPackage
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SellerId=A1XEXAMPLE5E6
  &Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2018-11-05T18%3A12%3A21
  &Version=2018-09-01
  &AmazonOrderId=903-1713775-3598252
  &MarketplaceId=A21TJRUUN4KGV
  &PackageRequestDetails.PackageDimensions.Length=12.00
  &PackageRequestDetails.PackageDimensions.Width=12.00
  &PackageRequestDetails.PackageDimensions.Height=12.00
  &PackageRequestDetails.PackageDimensions.Unit=cm
  &PackageRequestDetails.PackageWeight.Unit=23.00
  &PackageRequestDetails.PackageWeight.Value=g
  &PackageRequestDetails.PackagePickupSlot.SlotId=Xyt123bbdg=
  &PackageRequestDetails.PackagePickupSlot.PickupTimeStart=2018-02-21T07:30:00.00Z
  &PackageRequestDetails.PackagePickupSlot.PickupTimeEnd=2018-02-21T10:30:00.00Z
  &PackageRequestDetails.PackageIdentifier=Package1

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<CreateScheduledPackageResponse xmlns="http://mws.amazonaws.in/EasyShip/2018-09-01">
    <CreateScheduledPackageResult>
        <ScheduledPackage>
            <ScheduledPackageId>
                <AmazonOrderId>903-1713775-3598252</AmazonOrderId>
                <PackageId>1ab0f06a-9149-87e0-aba9-7098117872d6</PackageId>
            </ScheduledPackageId>
            <PackageDimensions>
                <Length>12.00</Length>
                <Width>12.00</Width>
                <Height>12.00</Height>
                <Unit>cm</Unit>
            </PackageDimensions>
            <PackageWeight>
                <Unit>g</Unit>
                <Value>23.00</Value>
            </PackageWeight>
            <PackagePickupSlot>
                <SlotId>Xyt123bbdg=</SlotId>
                <PickupTimeStart>2018-02-19T14:00:00.50+05:30</PickupTimeStart>
                <PickupTimeEnd>2018-02-19T16:00:00.50+05:30</PickupTimeEnd>
            </PackagePickupSlot>
            <PackageStatus>ReadyForPickup</PackageStatus>
        </ScheduledPackage>
    </CreateScheduledPackageResult>
    <ResponseMetadata>
        <RequestId>adb18f0d-2076-48d4-99ef-fb4b9f892a4e</RequestId>
    </ResponseMetadata>
</CreateScheduledPackageResponse>

↑ Top