Developer Console

Available Amazon Data Portability LWA Scopes

The Available Amazon Data Portability LWA Scopes defines the supported type of data that the customer is authorizing to give access to your Application.

Scopes are divided in two categories, Category-1 and Category-2, based on the type of the customer data in each scope.

Category-1 Scopes

To gain access to Category-1 scopes, you will complete the business identity verification in Step 2. Identity and security assessment.

Customer Profile

The Customer Profile scope includes Amazon customer's profile information, such as profile photo, cover photo, bio or customer-configured privacy settings.

Identifiers:

  • Login with Amazon Scope Name: portability::customer_profile
  • Amazon Data Portability scopeId: portability-customer-profile

Customer Profile

Schema properties:

Properties Details Example value
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
images The customer's avatar and cover photos. N/A
images.url The image url. https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png
images.type The image type. coverPhoto
privacySettings The privacy settings set in the Edit Privacy page to show or hide certain widgets or content created in the profile page. The values sometimes have a default value, and some of these settings are deprecated or could be a feature that's not available in all marketplaces. N/A
privacySettings.activityOnYourProfileVisibility The visibility of the activity timeline. public
privacySettings.sensitiveActivityVisibility The visibility of sensitive items. public
privacySettings.babyRegistryVisibility The visibility of the baby registry. private
privacySettings.topReviewerBadgesVisibility The visibility of the top reviewer badge. public
privacySettings.topContributorStatusVisibility The visibility of the top contributor status. private
privacySettings.whoYouFollowVisibility The visibility of the list of entities a customer follows. private
privacySettings.publicWishListVisibility The visibility of the public wishlist. public
privacySettings.reviewsVisibility The visibility of the review. public
privacySettings.weddingRegistryVisibility The visibility of the wedding registry. private
profileAttributes The profile attributes. N/A
profileAttributes.location The location. Germany
profileAttributes.publicName The name set on the profile page. John Doe
profileAttributes.bio The bio. Professional Tester
profileAttributes.occupation The occupation. QA Engineer
profileAttributes.website The link to a website. https://www.example.com
profileAttributes.facebookLink The link to the Facebook account. https://www.facebook.com/username
profileAttributes.pinterestLink The link to the Pinterest account. https://pinterest.com/username
profileAttributes.twitterLink The link to the Twitter account. https://www.twitter.com/username
profileAttributes.instagramLink The link to the Instagram account. https://www.instagram.com/username
profileAttributes.youtubeLink The link to the YouTube account. https://www.youtube.com/channel/channel

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Customer Profile",
  "description": "Includes customer profile information, such as profile photo, cover photo, bio or customer-configured privacy settings.",
  "type": "object",
  "unevaluatedProperties": false,
  "properties": {
    "eventDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
    },
    "images": {
      "description": "The customer's profile and cover photos.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "The image url (e.g., https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png)."
          },
          "type": {
            "description": "The image type (e.g., coverPhoto).",
            "type": "string",
            "enum": [
              "coverPhoto",
              "profilePhoto"
            ]
          }
        },
        "required": [
          "url",
          "type"
        ],
        "unevaluatedProperties": false
      }
    },
    "privacySettings": {
      "description": "The privacy settings set in the Edit Privacy page to show or hide certain widgets or content created in the profile page. The values sometimes have a default value, and some of these settings are deprecated or could be a feature that's not available in all marketplaces.",
      "type": "object",
      "properties": {
        "activityOnYourProfileVisibility": {
          "description": "The visibility of the activity timeline (e.g., public).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "sensitiveActivityVisibility": {
          "description": "The visibility of sensitive items (e.g., public).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "babyRegistryVisibility": {
          "description": "The visibility of the baby registry (e.g., private).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "topReviewerBadgesVisibility": {
          "description": "The visibility of the top reviewer badge (e.g., public).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "topContributorStatusVisibility": {
          "description": "The visibility of the top contributor status (e.g., private).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "whoYouFollowVisibility": {
          "description": "The visibility of the list of entities a customer follows (e.g., private).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "publicWishListVisibility": {
          "description": "The visibility of the public wishlist (e.g., public).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "reviewsVisibility": {
          "description": "The visibility of the review (e.g., public).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "weddingRegistryVisibility": {
          "description": "The visibility of the wedding registry (e.g., private).",
          "type": "string",
          "enum": [
            "private",
            "public"
          ]
        },
        "unevaluatedProperties": false
      }
    },
    "profileAttributes": {
      "description": "The profile attributes.",
      "type": "object",
      "properties": {
        "location": {
          "description": "The location (e.g., Germany).",
          "type": "string"
        },
        "publicName": {
          "description": "The name set on the profile page (e.g., John Doe).",
          "type": "string"
        },
        "bio": {
          "description": "The bio (e.g., Professional Tester).",
          "type": "string"
        },
        "occupation": {
          "description": "The occupation (e.g., QA Engineer).",
          "type": "string"
        },
        "website": {
          "description": "The link to a website (e.g., https://www.example.com)",
          "type": "string"
        },
        "facebookLink": {
          "description": "The link to the Facebook account (e.g., https://www.facebook.com/username).",
          "type": "string"
        },
        "pinterestLink": {
          "description": "The link to the Pinterest account (e.g., https://pinterest.com/username).",
          "type": "string"
        },
        "twitterLink": {
          "description": "The link to the Twitter account (e.g., https://www.twitter.com/username).",
          "type": "string"
        },
        "instagramLink": {
          "description": "The link to the Instagram account (e.g., https://www.instagram.com/username).",
          "type": "string"
        },
        "youtubeLink": {
          "description": "The link to the YouTube account (e.g., https://www.youtube.com/channel/channel).",
          "type": "string"
        }
      },
      "required": [
        "publicName"
      ],
      "unevaluatedProperties": false
    }
  },
  "required": [
    "eventDate",
    "profileAttributes"
  ]
}

Sample data based on the sample schema:

[
  {
    "images": [
      {
        "url": "https://images-fe.ssl-images-amazon.com/images/S/amazon-cover-photo/default._SX110_.png",
        "type": "coverPhoto" 
      }
    ],
    "privacySettings": {
      "activityOnYourProfileVisibility": "public",
      "sensitiveActivityVisibility": "public",
      "babyRegistryVisibility": "private",
      "topReviewerBadgesVisibility": "public",
      "topContributorStatusVisibility": "private",
      "whoYouFollowVisibility": "private",
      "publicWishListVisibility": "public",
      "reviewsVisibility": "public",
      "weddingRegistryVisibility": "private"
    },
    "profileAttributes": {
      "location": "Germany",
      "publicName": "John Doe",
      "bio": "Professional Tester",
      "occupation": "QA Engineer",
      "website": "https://www.example.com",
      "facebookLink": "https://www.facebook.com/username",
      "pinterestLink": "https://pinterest.com/username",
      "twitterLink": "https://www.twitter.com/username",
      "instagramLink": "https://www.instagram.com/username",
      "youtubeLink": "https://www.youtube.com/channel/channel"
    }
  }
]

Product Reviews (EU)

The Product Reviews (EU) scope includes Amazon customer's product reviews, with details such as review text, image references, video references and rating insights.

Identifiers:

  • Login with Amazon Scope Name: portability::product_reviews
  • Amazon Data Portability scopeId: portability-product-reviews

Product Reviews

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
asin The identifier of the reviewed product, a unique ten-digit alphanumeric code. B08FXVRFL9
versionID The sequential identifier for the review version. 3
imageURLs The URL of the images uploaded and stored in the Amazon systems. https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg
videoURLs The URL of the video uploaded and stored in the Amazon systems. https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4
starRating The numeric rating value in the range of 1-5. It relates to the number of stars assigned to the product. 5
text The text part of the review. Pretty good puzzle
title The title of the review. Recommended
featureRatings The list of pairs of product attributes with the numeric rating value in reference to the product. Flavor:4
status The status of the review. approved

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Product Reviews",
  "type": "array",
  "description": "Includes product reviews provided by the customer, with details such as the review text, image references, video references and rating insights.",
  "items": {
    "type": "object",
    "description": "Review contents",
    "properties": {
      "marketplace": {
        "type": "string",
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. (e.g., DE).",
        "pattern": "^[A-Z]{2}$"
      },
      "eventDate": {
        "type": "string",
        "format": "date-time",
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
      },
      "asin": {
        "type": "string",
        "description": "The identifier of the reviewed product, a unique ten-digit alphanumeric code (e.g., B08FXVRFL9)."
      },
      "versionID": {
        "type": "integer",
        "description": "The sequential identifier for the review version. (e.g., 3)."
      },
      "imageURLs": {
        "type": "array",
        "description": "The URL of the images uploaded and stored in the Amazon systems. (e.g., https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg).",
        "items": {
          "type": "string"
        }
      },
      "videoURLs": {
        "type": "array",
        "description": "The URL of the video uploaded and stored in the Amazon systems (e.g., https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4).",
        "items": {
          "type": "string"
        }
      },
      "starRating": {
        "type": "integer",
        "description": "The numeric rating value in the range of 1-5. It relates to the number of stars assigned to the product (e.g., 5)."
      },
      "text": {
        "type": "string",
        "description": "The text part of the review (e.g., Pretty good puzzle)."
      },
      "title": {
        "type": "string",
        "description": "The title of the review (e.g., Recommended)."
      },
      "featureRatings": {
        "type": "array",
        "description": "The list of pairs of product attributes with the numeric rating value in reference to the product (e.g., Flavor:4).",
        "items": {
          "type": "string"
        }
      },
      "status": {
        "type": "string",
        "description": "The status of the review (e.g., approved)."
      }
    },
    "required": [
      "marketplace",
      "eventDate",
      "asin",
      "versionID"
    ],
    "unevaluatedProperties": false
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "DE",
    "eventDate": "2021-02-08T12:34:20Z",
    "asin": "B08FXVRFL9", 
    "versionID": 3,
    "imageURLs": [
      "https://m.media-amazon.com/images/I/61dJstwX20L._SL1600_.jpg"
    ], 
    "videoURLs": [
      "https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-eu-west-1-prod/a34ef979-678d-417a-b804-227568ea2ad9/default.jobtemplate.mp4.480.mp4"
    ],
    "starRating": 5,
    "text": "Pretty good puzzle",
    "title": "Recommended",
    "featureRatings": "Flavor:4",
    "status": "approved"
  }
]

Seller Feedback (EU)

The Seller Feedback (EU) scope includes Amazon customer's feedback provided to the third-party sellers, including details such as feedback text, ratings and customer selected reason codes.

Identifiers:

  • Login with Amazon Scope Name: portability::seller_feedback
  • Amazon Data Portability scopeId: portability-seller-feedback

Seller Feedback

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
feedbackDate The date when the feedback was given, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-09-29T11:04:43.305Z
feedbackRating The star rating provided by the customer. 1
feedbackText The feedback text provided by the customer. Lorem Ipsum
dealAgain The customer provided response stating if they will purchase from the seller again. true
itemArrivedOnTime The customer provided response stating if the item arrived on time. true
promptOnCorteousService The customer provided response stating if the communication from the seller was good. false
itemAsDescribed The customer provided response stating if the item was received as described by the seller. true
whatWentWrong The customer selected reason code indicating which issue they had with their order. Wrong Version or Size

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Seller Feedback",
  "description": "Includes feedback provided by the customer to the third-party sellers, including details such as feedback text, ratings, and customer selected reason codes.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "marketplace": {
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. (e.g., DE).",
        "type": "string"
      },
      "eventDate": {
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
        "type": "string",
        "format": "date-time"
      },
      "feedbackDate": {
        "description": "The date when the feedback was given, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
        "type": "string",
        "format": "date-time"
      },
      "feedbackRating": {
        "description": "The star rating provided by the customer (e.g., 4).",
        "enum": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "feedbackText": {
        "description": "The feedback text provided by the customer (e.g., Lorem Ipsum).",
        "type": "string"
      },
      "dealAgain": {
        "description": "The customer provided response stating if they will purchase from the seller again (e.g., true).",
        "type": "boolean"
      },
      "itemArrivedOnTime": {
        "description": "The customer provided response stating if the item arrived on time (e.g., true).",
        "type": "boolean"
      },
      "promptCourteousService": {
        "description": "The customer provided response stating if the communication from the seller was good (e.g., false).",
        "type": "boolean"
      },
      "itemAsDescribed": {
        "description": "The customer provided response stating if the item was received as described by the seller (e.g., true).",
        "type": "boolean"
      },
      "whatWentWrong": {
        "enum": [
          "Completely Wrong Item",
          "Damaged Defective Other",
          "Did not receive my package",
          "Due to poor packaging",
          "Issue Not Listed Above",
          "Item Not As Described",
          "Just Not Happy With My Product",
          "Received my package late",
          "Return or Refund Issue",
          "Something was missing",
          "Wrong Version or Size"
        ],
        "description": "The customer selected reason code indicating which issue they had with their order (e.g., Wrong Version or Size)."
      }
    },
    "required": [
      "marketplace",
      "eventDate",
      "feedbackDate",
      "feedbackRating"
    ]
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "DE",
    "eventDate": "2021-09-29T11:04:43.305Z",
    "feedbackDate": "2021-09-29T11:04:43.305Z",
    "feedbackRating": 1,
    "feedbackText": "Reliable shop",
    "dealAgain": true,
    "itemArrivedOnTime": true, 
    "promptCourteousService": false,
    "itemAsDescribed": true,
    "whatWentWrong": "Wrong Version or Size"
  }
]

Category-2 Scopes

To gain access to Category-2 scopes, you will complete the business identity and data security verification in Step 2. Identity and security assessment.

Physical Orders (EU)

The Physical Orders (EU) scope includes Amazon customer's physical order history, with details like product names, quantity, and prices paid.

Identifiers:

  • Login with Amazon Scope Name: portability::physical_orders
  • Amazon Data Portability scopeId: portability-physical-orders

Physical Orders

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
productName The title of the product as displayed on the Amazon Retail Website product page. Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, latest model (2021 release), Lavender
website The domain of the Amazon Retail Website where the order was placed. Amazon.fr, Amazon.it, Amazon.de
orderId The unique identifier for an order which the product belongs to. 701-7195934-7003458
orderDate The date when the customer placed the order, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2023-04-11T08:26:22Z
currencyCode The currency code for the price, formatted according to ISO 4217 standard. EUR
quantity The quantity of the product. 1
productCondition The condition of the product, whether it is used or new. New, Used
totalOwed The total price of the order including all charges and discounts. 21.39

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Physical Orders",
  "description": "Includes customer's physical order history, with details like product names, quantity and prices paid.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "eventDate": {
        "type": "string",
        "format": "date-time",
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
      },
      "orderDate": {
        "type": "string",
        "format": "date-time",
        "description": "The date when the customer placed the order, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z)."
      },
      "marketplace": {
        "type": "string",
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE).",
        "pattern": "^[A-Z]{2}$"
      },
      "productName": {
        "type": "string",
        "description": "The title of the product as displayed on the Amazon Retail Website product page (e.g., Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, Lavender)."
      },
      "website": {
        "type": "string",
        "description": "The domain of the Amazon Retail Website where the order was placed (e.g., Amazon.fr, Amazon.de, Amazon.com.be, etc.)."
      },
      "orderId": {
        "type": "string",
        "description": "The unique identifier for an order which the product belongs to (e.g., 701-7195934-7003458)."
      },
      "currencyCode": {
        "type": "string",
        "description": "The currency code for the price, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
      },
      "quantity": {
        "type": "integer",
        "description": "The quantity of the product (e.g., 5)."
      },
      "productCondition": {
        "type": "string",
        "description": "The condition of the product, whether it is used or new (e.g., New, Used)."
      },
      "totalOwed": {
        "type": "number",
        "description": "The total price of the order including all charges and discounts (e.g., 21.39)."
      }
    },
    "unevaluatedProperties": false,
    "required": [
      "marketplace",
      "eventDate",
      "orderDate"
    ]
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "FR",
    "eventDate": "2021-02-08T12:34:20Z",
    "orderDate": "2021-02-08T11:04:43.305Z",
    "productName": "Amazon Fire HD 10 tablet, 1080p Full HD, 32 GB, latest model (2021 release), Lavender",
    "website": "Amazon.fr",
    "orderId": "701-7195934-7003458",
    "currencyCode": "EUR",
    "quantity": 1,
    "productCondition": "New",
    "totalOwed": 21.39
  }
]

Digital Orders (EU)

The Digital Orders (EU) scope includes Amazon customer's digital order history, with details such as product name, prices paid and quantity ordered.

Identifiers:

  • Login with Amazon Scope Name: portability::digital_orders
  • Amazon Data Portability scopeId : portability-digital-orders

Digital Orders Items

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
baseCurrencyCode The currency code for the item price, formatted according to ISO 4217 standard. EUR
digitalOrderItemId The identifier of the item from the order. CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7
installmentOurPrice The price of the installment, if it is an installment order. 1.14
installmentOurPriceCurrencyCode The currency code for the installment order, formatted according to ISO 4217 standard. EUR
quantityOrdered The quantity the item was ordered. 1
title The title of the item. Paramount+
giftItem The flag that marks if the item was purchased as a gift. false
isOrderEligibleForPrimeBenefit The flag that marks if the order is eligible for prime benefits. Yes

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Digital Orders Items",
  "description": "Includes account's digital order history items with details like product names, prices paid and quantity ordered.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "marketplace": {
        "type": "string",
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
      },
      "eventDate": {
        "type": "string",
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
        "format": "date-time"
      },
      "baseCurrencyCode": {
        "type": "string",
        "description": "The currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
      },
      "digitalOrderItemId": {
        "type": "string",
        "description": "The identifier of the item from the order (e.g., CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7)."
      },
      "installmentOurPrice": {
        "type": "string",
        "description": "The price of the installment, if it is an installment order (e.g., 1.14)."
      },
      "installmentOurPriceCurrencyCode": {
        "type": "string",
        "description": "The currency code for the installment order, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
      },
      "quantityOrdered": {
        "type": "number",
        "description": "The quantity the item was ordered (e.g., 2)."
      },
      "title": {
        "type": "string",
        "description": "The title of the item (e.g., Paramount+)."
      },
      "giftItem": {
        "type": "boolean",
        "description": "The flag that marks if the item was purchased as a gift (e.g., true)."
      },
      "isOrderEligibleForPrimeBenefit": {
        "description": "The flag that marks if the order is eligible for prime benefits (e.g., Yes).",
        "type": "string",
        "enum": [
          "Yes",
          "No"
        ]
      }
    },
    "required": [
      "marketplace",
      "eventDate",
      "baseCurrencyCode",
      "digitalOrderItemId",
      "quantityOrdered",
      "giftItem"
    ],
    "unevaluatedProperties": false
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "FR",
    "eventDate": "2021-02-08T12:34:20Z",
    "baseCurrencyCode": "EUR",
    "digitalOrderItemId": "CLCQKDL52GAHOP93C5I4FT0IPKV77D74HBD4SUCHAF7",
    "installmentOurPrice": "1.14",
    "installmentOurPriceCurrencyCode": "EUR",
    "quantityOrdered": 1,
    "title": "Paramount+",
    "giftItem": true,
    "isOrderEligibleForPrimeBenefit": "Yes"
  }
]

Digital Orders

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
orderId The unique identifier for an order which the product belongs to. D01-4762016-7053852
isOrderAPreorder The flag that marks if a digital order was a pre-order. false
orderStatus The status code describing the order status. SUCCESS
relatedPhysicalOrderId The related physical order identifier, if it exists. 111-5645993-5749423
subscriptionOrderType The type of the order if it is a subscription. Subscription_Renewal

Sample schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Digital Orders",
  "description": "Includes account's digital order history, with details like order status and whether it relates to a subscription.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "marketplace": {
        "type": "string",
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
      },
      "eventDate": {
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
        "type": "string",
        "format": "date-time"
      },
      "orderId": {
        "type": "string",
        "description": "The unique identifier for an order which the product belongs to (e.g., D01-4762016-7053852)."
      },
      "isOrderAPreorder": {
        "description": "The flag that marks if a digital order was a pre-order (e.g., false).",
        "type": "boolean"
      },
      "orderStatus": {
        "description": "The status code describing the order status (e.g., SUCCESS).",
        "type": "string",
        "enum": [
          "PENDING",
          "CANCELLED_BY_AMAZON",
          "PENDING_PREORDER_RELEASE",
          "COMBINED_WITH_SIMILAR_ORDER",
          "USER_CANCELED",
          "N/A",
          "SUCCESS"
        ]
      },
      "relatedPhysicalOrderId": {
        "type": "string",
        "description": "The related physical order identifier, if it exists. (e.g., 111-5645993-5749423)."
      },
      "subscriptionOrderType": {
        "type": "string",
        "description": "The type of the order if it is a subscription (e.g., Subscription_Renewal)."
      }
    },
    "required": [
      "orderId",
      "marketplace",
      "eventDate",
      "isOrderAPreorder",
      "orderStatus"
    ],
    "unevaluatedProperties": false
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "FR",
    "eventDate": "2021-02-08T12:34:20Z",
    "orderId": "D01-4762016-7053852",
    "isOrderAPreorder": false,
    "orderStatus": "SUCCESS",
    "relatedPhysicalOrderId": "111-5645993-5749423",
    "subscriptionOrderType": "Subscription_Renewal"
  }
]

Digital Orders Monetary

Schema properties:

Properties Details Example value
marketplace The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard. DE
eventDate The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). 2021-02-08T12:34:20Z
deliveryPacketId The identifier of the delivery packet, corresponding to a processed item. GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG
transactionAmount The monetary amount of the transaction. 2.95
affectedItemQuantity The quantity of the item. 5
fxCurrencyCode The foreign exchange currency code for the item price, formatted according to ISO 4217 standard. EUR
fxTransactionAmount The foreign exchange transaction amount. 1.17
digitalOrderItemId The identifier of the item in the order. VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG
baseCurrencyCode The currency code for the item price, formatted according to ISO 4217 standard. EUR
monetaryComponentTypeCode The type of the transaction. Price Amount

Schema Sample

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Digital Orders Monentary",
  "description": "Includes customer's digital order history monetary information about each ordered item.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "marketplace": {
        "type": "string",
        "description": "The marketplace where the record was generated, formatted according to ISO 3166-1 alpha-2 standard (e.g., DE)."
      },
      "eventDate": {
        "type": "string",
        "description": "The date when the record was generated, in the ISO 8601 date-time format and UTC time zone (e.g., YYYY-MM-DDThh:mm:ss.sssZ - 2021-09-29T11:04:43.305Z).",
        "format": "date-time"
      },
      "deliveryPacketId": {
        "type": "string",
        "description": "The identifier of the delivery packet, corresponding to a processed item (e.g., GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG)."
      },
      "transactionAmount": {
        "type": "number",
        "description": "The monetary amount of the transaction (e.g., 2.95)."
      },
      "affectedItemQuantity": {
        "type": "number",
        "description": "The quantity of the item (e.g., 5)."
      },
      "fxCurrencyCode": {
        "type": "string",
        "description": "The foreign exchange currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
      },
      "fxTransactionAmount": {
        "type": "string",
        "description": "The foreign exchange transaction amount (e.g., 1.17)."
      },
      "digitalOrderItemId": {
        "type": "string",
        "description": "The identifier of the item in the order (e.g., VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG)."
      },
      "baseCurrencyCode": {
        "type": "string",
        "description": "The currency code for the item price, formatted according to ISO 4217 standard (e.g., EUR, GBP, etc.)."
      },
      "monetaryComponentTypeCode": {
        "type": "string",
        "description": "The type of the transaction (e.g., Price Amount)."
      }
    },
    "required": [
      "marketplace",
      "eventDate",
      "deliveryPacketId",
      "affectedItemQuantity",
      "digitalOrderItemId"
    ],
    "unevaluatedProperties": false
  }
}

Sample data based on the sample schema:

[
  {
    "marketplace": "FR",
    "eventDate": "2021-02-08T12:34:20Z",
    "deliveryPacketId": "GE0VRELSG8IJNJRAH6T6VB3PILHPIG0LCRKGHKJMD5SDG",
    "transactionAmount": 2.95,
    "affectedItemQuantity": 5,
    "fxCurrencyCode": "EUR",
    "fxTransactionAmount": "1.17",
    "digitalOrderItemId": "VNCG8HRN6AU4I3HSIICNJL8RQU4IKODO816N05FHJ170PQGUJIDG",
    "baseCurrencyCode": "EUR",
    "monetaryComponentTypeCode": "Price Amount"
  }
]

Last updated: Mar 07, 2024