diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..86d4c2dd --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +generated diff --git a/README.md b/README.md index 16c9975d..30ff1ee9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ +## Jazva Notes + +We modified the code base, but still should periodically merge upstream/main into our branch and push +To build: + +1. change version in [generate/pom.xml] +2. global replace the new version in generate/compile.sh +3. run generate/compile.sh (which has mvn install:install-file commented out) +4. fix the absolute path in mvn install:install-file +5. manually run mvn install:install-file line to make sure it pushes to the lib folder in main jazva project +6. add the new version to git in jazva project ./lib/com/amazon/sellingpartnerapi/... +7. update jazvas main pom.xml to use the new version + +Note: sometimes we need to update the authorization-authentication module as well, which is a dependency in the above pom. The lines to build it are in the same compile.sh file + + ## Selling Partner API Models This repository contains Swagger models for developers to use to create software to call Selling Partner APIs. Developers can use [swagger codegen](https://github.com/swagger-api/swagger-codegen) to generate client libraries from these models. Please refer to [selling-partner-api-docs](https://github.com/amzn/selling-partner-api-docs) for additional documentation and read the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md) for instructions to get started. diff --git a/clients/sellingpartner-api-aa-java/pom.xml b/clients/sellingpartner-api-aa-java/pom.xml index b209b2ce..f9d5c0bf 100644 --- a/clients/sellingpartner-api-aa-java/pom.xml +++ b/clients/sellingpartner-api-aa-java/pom.xml @@ -6,7 +6,7 @@ com.amazon.sellingpartnerapi sellingpartnerapi-aa-java jar - 1.0 + 1.0.3 @@ -47,13 +47,13 @@ com.amazonaws aws-java-sdk-signer - 1.11.610 + 1.12.408 org.projectlombok lombok - 1.18.8 + 1.18.26 provided @@ -87,7 +87,7 @@ org.junit.jupiter junit-jupiter-migrationsupport - 5.5.1 + 5.9.2 test @@ -104,10 +104,16 @@ 3.9 + + + + + + - org.apache.httpcomponents - httpclient - 4.5.13 + org.apache.httpcomponents.client5 + httpclient5 + 5.2.1 diff --git a/clients/sellingpartner-api-aa-java/resources/swagger-codegen/templates/ApiClient.mustache b/clients/sellingpartner-api-aa-java/resources/swagger-codegen/templates/ApiClient.mustache index 993d2e24..9b51e73e 100644 --- a/clients/sellingpartner-api-aa-java/resources/swagger-codegen/templates/ApiClient.mustache +++ b/clients/sellingpartner-api-aa-java/resources/swagger-codegen/templates/ApiClient.mustache @@ -78,6 +78,8 @@ public class ApiClient { private HttpLoggingInterceptor loggingInterceptor; + private String rdt = null; + private LWAAuthorizationSigner lwaAuthorizationSigner; private AWSSigV4Signer awsSigV4Signer; private RateLimiter rateLimiter; @@ -128,6 +130,11 @@ public class ApiClient { return this; } + public ApiClient setRdt(String rdt) { + this.rdt = rdt; + return this; + } + /** * Get HTTP client * @@ -1048,7 +1055,13 @@ public class ApiClient { request = reqBuilder.method(method, reqBody).build(); } - request = lwaAuthorizationSigner.sign(request); + if (rdt == null) { + request = lwaAuthorizationSigner.sign(request); + } else { + request = request.newBuilder() + .addHeader("x-amz-access-token", rdt) + .build(); + } request = awsSigV4Signer.sign(request); return request; diff --git a/generate/JSON.java b/generate/JSON.java new file mode 100644 index 00000000..ccd62355 --- /dev/null +++ b/generate/JSON.java @@ -0,0 +1,397 @@ +/* + * Selling Partner API for Retail Procurement Transaction Status + * The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors. + * + * OpenAPI spec version: v1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package com.amazon.sellingpartner; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapter; +import com.google.gson.internal.bind.util.ISO8601Utils; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.google.gson.JsonElement; +import io.gsonfire.GsonFireBuilder; +import io.gsonfire.TypeSelector; + +import com.amazon.sellingpartner.model.vendortransactionstatus.*; +import okio.ByteString; + +import java.io.IOException; +import java.io.StringReader; +import java.lang.reflect.Type; +import java.text.DateFormat; +import java.text.ParseException; +import java.text.ParsePosition; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.util.Date; +import java.util.Map; +import java.util.HashMap; + +public class JSON { + private Gson gson; + private boolean isLenientOnJson = false; + private DateTypeAdapter dateTypeAdapter = new DateTypeAdapter(); + private SqlDateTypeAdapter sqlDateTypeAdapter = new SqlDateTypeAdapter(); + private OffsetDateTimeTypeAdapter offsetDateTimeTypeAdapter = new OffsetDateTimeTypeAdapter(); + private LocalDateTypeAdapter localDateTypeAdapter = new LocalDateTypeAdapter(); + private ByteArrayAdapter byteArrayAdapter = new ByteArrayAdapter(); + + public static GsonBuilder createGson() { + GsonFireBuilder fireBuilder = new GsonFireBuilder() + ; + GsonBuilder builder = fireBuilder.createGsonBuilder(); + return builder; + } + + private static String getDiscriminatorValue(JsonElement readElement, String discriminatorField) { + JsonElement element = readElement.getAsJsonObject().get(discriminatorField); + if(null == element) { + throw new IllegalArgumentException("missing discriminator field: <" + discriminatorField + ">"); + } + return element.getAsString(); + } + + private static Class getClassByDiscriminator(Map classByDiscriminatorValue, String discriminatorValue) { + Class clazz = (Class) classByDiscriminatorValue.get(discriminatorValue.toUpperCase()); + if(null == clazz) { + throw new IllegalArgumentException("cannot determine model class of name: <" + discriminatorValue + ">"); + } + return clazz; + } + + public JSON() { + gson = createGson() + .registerTypeAdapter(Date.class, dateTypeAdapter) + .registerTypeAdapter(java.sql.Date.class, sqlDateTypeAdapter) + .registerTypeAdapter(OffsetDateTime.class, offsetDateTimeTypeAdapter) + .registerTypeAdapter(LocalDate.class, localDateTypeAdapter) + .registerTypeAdapter(byte[].class, byteArrayAdapter) + .create(); + } + + /** + * Get Gson. + * + * @return Gson + */ + public Gson getGson() { + return gson; + } + + /** + * Set Gson. + * + * @param gson Gson + * @return JSON + */ + public JSON setGson(Gson gson) { + this.gson = gson; + return this; + } + + public JSON setLenientOnJson(boolean lenientOnJson) { + isLenientOnJson = lenientOnJson; + return this; + } + + /** + * Serialize the given Java object into JSON string. + * + * @param obj Object + * @return String representation of the JSON + */ + public String serialize(Object obj) { + return gson.toJson(obj); + } + + /** + * Deserialize the given JSON string to Java object. + * + * @param Type + * @param body The JSON string + * @param returnType The type to deserialize into + * @return The deserialized Java object + */ + @SuppressWarnings("unchecked") + public T deserialize(String body, Type returnType) { + try { + if (isLenientOnJson) { + JsonReader jsonReader = new JsonReader(new StringReader(body)); + // see https://google-gson.googlecode.com/svn/trunk/gson/docs/javadocs/com/google/gson/stream/JsonReader.html#setLenient(boolean) + jsonReader.setLenient(true); + return gson.fromJson(jsonReader, returnType); + } else { + return gson.fromJson(body, returnType); + } + } catch (JsonParseException e) { + // Fallback processing when failed to parse JSON form response body: + // return the response body string directly for the String return type; + if (returnType.equals(String.class)) + return (T) body; + else throw (e); + } + } + + /** + * Gson TypeAdapter for Byte Array type + */ + public class ByteArrayAdapter extends TypeAdapter { + + @Override + public void write(JsonWriter out, byte[] value) throws IOException { + if (value == null) { + out.nullValue(); + } else { + out.value(ByteString.of(value).base64()); + } + } + + @Override + public byte[] read(JsonReader in) throws IOException { + switch (in.peek()) { + case NULL: + in.nextNull(); + return null; + default: + String bytesAsBase64 = in.nextString(); + ByteString byteString = ByteString.decodeBase64(bytesAsBase64); + return byteString.toByteArray(); + } + } + } + + /** + * Gson TypeAdapter for JSR310 OffsetDateTime type + */ + public static class OffsetDateTimeTypeAdapter extends TypeAdapter { + + private DateTimeFormatter formatter; + + public OffsetDateTimeTypeAdapter() { + this(DateTimeFormatter.ISO_OFFSET_DATE_TIME); + } + + public OffsetDateTimeTypeAdapter(DateTimeFormatter formatter) { + this.formatter = formatter; + } + + public void setFormat(DateTimeFormatter dateFormat) { + this.formatter = dateFormat; + } + + @Override + public void write(JsonWriter out, OffsetDateTime date) throws IOException { + if (date == null) { + out.nullValue(); + } else { + out.value(formatter.format(date)); + } + } + + @Override + public OffsetDateTime read(JsonReader in) throws IOException { + switch (in.peek()) { + case NULL: + in.nextNull(); + return null; + default: + String date = in.nextString(); + if (date == null || date.trim().isEmpty()) { + return null; + } + if (date.endsWith("+0000")) { + date = date.substring(0, date.length()-5) + "Z"; + } + return OffsetDateTime.parse(date, formatter); + } + } + } + + /** + * Gson TypeAdapter for JSR310 LocalDate type + */ + public class LocalDateTypeAdapter extends TypeAdapter { + + private DateTimeFormatter formatter; + + public LocalDateTypeAdapter() { + this(DateTimeFormatter.ISO_LOCAL_DATE); + } + + public LocalDateTypeAdapter(DateTimeFormatter formatter) { + this.formatter = formatter; + } + + public void setFormat(DateTimeFormatter dateFormat) { + this.formatter = dateFormat; + } + + @Override + public void write(JsonWriter out, LocalDate date) throws IOException { + if (date == null) { + out.nullValue(); + } else { + out.value(formatter.format(date)); + } + } + + @Override + public LocalDate read(JsonReader in) throws IOException { + switch (in.peek()) { + case NULL: + in.nextNull(); + return null; + default: + String date = in.nextString(); + return LocalDate.parse(date, formatter); + } + } + } + + public JSON setOffsetDateTimeFormat(DateTimeFormatter dateFormat) { + offsetDateTimeTypeAdapter.setFormat(dateFormat); + return this; + } + + public JSON setLocalDateFormat(DateTimeFormatter dateFormat) { + localDateTypeAdapter.setFormat(dateFormat); + return this; + } + + /** + * Gson TypeAdapter for java.sql.Date type + * If the dateFormat is null, a simple "yyyy-MM-dd" format will be used + * (more efficient than SimpleDateFormat). + */ + public static class SqlDateTypeAdapter extends TypeAdapter { + + private DateFormat dateFormat; + + public SqlDateTypeAdapter() { + } + + public SqlDateTypeAdapter(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + public void setFormat(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + @Override + public void write(JsonWriter out, java.sql.Date date) throws IOException { + if (date == null) { + out.nullValue(); + } else { + String value; + if (dateFormat != null) { + value = dateFormat.format(date); + } else { + value = date.toString(); + } + out.value(value); + } + } + + @Override + public java.sql.Date read(JsonReader in) throws IOException { + switch (in.peek()) { + case NULL: + in.nextNull(); + return null; + default: + String date = in.nextString(); + try { + if (dateFormat != null) { + return new java.sql.Date(dateFormat.parse(date).getTime()); + } + return new java.sql.Date(ISO8601Utils.parse(date, new ParsePosition(0)).getTime()); + } catch (ParseException e) { + throw new JsonParseException(e); + } + } + } + } + + /** + * Gson TypeAdapter for java.util.Date type + * If the dateFormat is null, ISO8601Utils will be used. + */ + public static class DateTypeAdapter extends TypeAdapter { + + private DateFormat dateFormat; + + public DateTypeAdapter() { + } + + public DateTypeAdapter(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + public void setFormat(DateFormat dateFormat) { + this.dateFormat = dateFormat; + } + + @Override + public void write(JsonWriter out, Date date) throws IOException { + if (date == null) { + out.nullValue(); + } else { + String value; + if (dateFormat != null) { + value = dateFormat.format(date); + } else { + value = ISO8601Utils.format(date, true); + } + out.value(value); + } + } + + @Override + public Date read(JsonReader in) throws IOException { + try { + switch (in.peek()) { + case NULL: + in.nextNull(); + return null; + default: + String date = in.nextString(); + try { + if (dateFormat != null) { + return dateFormat.parse(date); + } + return ISO8601Utils.parse(date, new ParsePosition(0)); + } catch (ParseException e) { + throw new JsonParseException(e); + } + } + } catch (IllegalArgumentException e) { + throw new JsonParseException(e); + } + } + } + + public JSON setDateFormat(DateFormat dateFormat) { + dateTypeAdapter.setFormat(dateFormat); + return this; + } + + public JSON setSqlDateFormat(DateFormat dateFormat) { + sqlDateTypeAdapter.setFormat(dateFormat); + return this; + } + +} diff --git a/generate/compile.sh b/generate/compile.sh new file mode 100755 index 00000000..b758867d --- /dev/null +++ b/generate/compile.sh @@ -0,0 +1,96 @@ +#!/bin/bash + +cd .. +rm -rf generated +mkdir -p generated/spapi/src/main/java/com/amazon/sellingpartner + +basePackage="com.amazon.sellingpartner" +#models=(models/*/*) + +generate () { + java -jar generate/swagger-codegen-cli.jar generate \ + --input-spec $2 \ + --lang java \ + --template-dir clients/sellingpartner-api-aa-java/resources/swagger-codegen/templates \ + --output generated/spapi \ + --invoker-package "$basePackage" \ + --api-package "$basePackage.api.$1" \ + --model-package "$basePackage.model.$1" \ + --group-id "com.amazon" \ + --artifact-id "selling-partner-api" \ + --additional-properties dateLibrary=java8 + +} +generate "aplus" "models/aplus-content-api-model/aplusContent_2020-11-01.json" +generate "authorization" "models/authorization-api-model/authorization.json" +generate "catalogv0" "models/catalog-items-api-model/catalogItemsV0.json" +generate "catalogv20" "models/catalog-items-api-model/catalogItems_2020-12-01.json" +generate "catalogv22" "models/catalog-items-api-model/catalogItems_2022-04-01.json" +generate "easyship" "models/easy-ship-model/easyShip_2022-03-23.json" +generate "fbainbound" "models/fba-inbound-eligibility-api-model/fbaInbound.json" +generate "fbainventory" "models/fba-inventory-api-model/fbaInventory.json" +generate "fbaSmallandLight" "models/fba-small-and-light-api-model/fbaSmallandLight.json" +generate "feeds" "models/feeds-api-model/feeds_2021-06-30.json" +generate "finances" "models/finances-api-model/financesV0.json" +generate "fulfillmentinbound" "models/fulfillment-inbound-api-model/fulfillmentInboundV0.json" +generate "fulfillmentoutbound" "models/fulfillment-outbound-api-model/fulfillmentOutbound_2020-07-01.json" +generate "listing" "models/listings-items-api-model/listingsItems_2021-08-01.json" +generate "listingrestrictions" "models/listings-restrictions-api-model/listingsRestrictions_2021-08-01.json" +generate "merchantfulfillment" "models/merchant-fulfillment-api-model/merchantFulfillmentV0.json" +generate "messaging" "models/messaging-api-model/messaging.json" +generate "notifications" "models/notifications-api-model/notifications.json" +generate "orders" "models/orders-api-model/ordersV0.json" +generate "productfees" "models/product-fees-api-model/productFeesV0.json" +generate "productpricing" "models/product-pricing-api-model/productPricingV0.json" +generate "definitions" "models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json" +generate "reports" "models/reports-api-model/reports_2021-06-30.json" +generate "sales" "models/sales-api-model/sales.json" +generate "sellers" "models/sellers-api-model/sellers.json" +generate "services" "models/services-api-model/services.json" +generate "shipmentinvoicing" "models/shipment-invoicing-api-model/shipmentInvoicingV0.json" +generate "shipping" "models/shipping-api-model/shipping2.json" +generate "solicitations" "models/solicitations-api-model/solicitations.json" +generate "tokens" "models/tokens-api-model/tokens_2021-03-01.json" +generate "uploads" "models/uploads-api-model/uploads_2020-11-01.json" +generate "dfinventory" "models/vendor-direct-fulfillment-inventory-api-model/vendorDirectFulfillmentInventoryV1.json" +generate "dforders" "models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json" +generate "dfpayments" "models/vendor-direct-fulfillment-payments-api-model/vendorDirectFulfillmentPaymentsV1.json" +generate "dfshipping" "models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json" +generate "dftransactions" "models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json" +generate "vendorinvoices" "models/vendor-invoices-api-model/vendorInvoices.json" +generate "vendororders" "models/vendor-orders-api-model/vendorOrders.json" +generate "vendorshipments" "models/vendor-shipments-api-model/vendorShipments.json" +generate "vendortransactionstatus" "models/vendor-transaction-status-api-model/vendorTransactionStatus.json" +# +## For every model in the models/ directory, and all subdirectories: +#for model in "${models[@]}" +#do +# # Generate a client library +# # --input-spec $model :: use the current model file +# # --lang java :: generate a Java library +# # --template-dir .../ :: use Amazon's premade Java template files +# # --output ../spapi :: put the generated library in ../spapi +# # --invoker-package "..." :: put the generated code in the given package +# # --api-package "..." :: put the generated api code in the given package +# # --model-package "..." :: put the generated model code in the given package +# # --group-id "..." :: package metadata +# # --artifact-id "..." :: package metadata +# # --additional-properties dateLibrary=java8 :: Use Java 8 date libraries +#done +# + + +#cd clients/sellingpartner-api-aa-java +#mvn clean package +#mvn install:install-file -Dfile=target/sellingpartnerapi-aa-java-1.0.3.jar -DgroupId=com.amazon.sellingpartnerapi -DartifactId=sellingpartnerapi-aa-java -Dversion=1.0.3 -Dpackaging=jar -DlocalRepositoryPath=/Users/levon/Projects/jazva/lib +#cd ../.. + +cp -a generate/JSON.java generated/spapi/src/main/java/com/amazon/sellingpartner/ +cp -r generate/pom.xml generated/spapi +cd generated/spapi +mvn clean package + +# install into jazva/lib check path +# fix path and run manually from root folder +cd ../.. +#mvn install:install-file -Dfile=generated/spapi/target/selling-partner-api-1.0.14.jar -Dsources=generated/spapi/target/selling-partner-api-1.0.14-sources.jar -Djavadoc=generated/spapi/target/selling-partner-api-1.0.14-javadoc.jar -DgroupId=com.amazon.sellingpartnerapi -DartifactId=selling-partner-api -Dversion=1.0.14 -Dpackaging=jar -DlocalRepositoryPath=/Users/levon/Projects/jazva/lib diff --git a/generate/pom.xml b/generate/pom.xml new file mode 100644 index 00000000..2fee1dc0 --- /dev/null +++ b/generate/pom.xml @@ -0,0 +1,259 @@ + + 4.0.0 + com.amazon + selling-partner-api + jar + selling-partner-api + 1.0.14 + https://github.com/swagger-api/swagger-codegen + Swagger Java + + scm:git:git@github.com:swagger-api/swagger-codegen.git + scm:git:git@github.com:swagger-api/swagger-codegen.git + https://github.com/swagger-api/swagger-codegen + + + + + Unlicense + http://www.apache.org/licenses/LICENSE-2.0 + repo + + + + + + Swagger + apiteam@swagger.io + Swagger + http://swagger.io + + + + + + + org.apache.maven.plugins + maven-enforcer-plugin + 3.0.0-M1 + + + enforce-maven + + enforce + + + + + 2.2.0 + + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + 2.12 + + + + loggerPath + conf/log4j.properties + + + -Xms512m -Xmx1500m + methods + pertest + + + + maven-dependency-plugin + + + package + + copy-dependencies + + + ${project.build.directory}/lib + + + + + + + + org.apache.maven.plugins + maven-jar-plugin + 2.2 + + + + jar + test-jar + + + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + 1.10 + + + add_sources + generate-sources + + add-source + + + + + src/main/java + + + + + add_test_sources + generate-test-sources + + add-test-source + + + + + src/test/java + + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.4 + + + attach-javadocs + + jar + + + + + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar-no-fork + + + + + + + + + + sign-artifacts + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + verify + + sign + + + + + + + + + + + + mylib + file://${project.basedir}/lib + + true + always + warn + + + + + + com.amazon.sellingpartnerapi + sellingpartnerapi-aa-java + 1.0.3 + + + io.swagger + swagger-annotations + ${swagger-core-version} + + + com.squareup.okhttp + okhttp + ${okhttp-version} + + + com.squareup.okhttp + logging-interceptor + ${okhttp-version} + + + + com.google.guava + guava + ${guava-version} + + + com.google.code.gson + gson + ${gson-version} + + + io.gsonfire + gson-fire + ${gson-fire-version} + + + + junit + junit + ${junit-version} + test + + + + 1.8 + ${java.version} + ${java.version} + 1.8.3 + 1.6.9 + 2.7.5 + 2.8.1 + 31.1-jre + 1.0.0 + 4.13.1 + UTF-8 + + diff --git a/generate/swagger-codegen-cli.jar b/generate/swagger-codegen-cli.jar new file mode 100644 index 00000000..8832259f Binary files /dev/null and b/generate/swagger-codegen-cli.jar differ diff --git a/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.jar b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.jar new file mode 100644 index 00000000..88a5ce49 Binary files /dev/null and b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.jar differ diff --git a/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.pom b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.pom new file mode 100644 index 00000000..c1e96cb3 --- /dev/null +++ b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/1.0.3/sellingpartnerapi-aa-java-1.0.3.pom @@ -0,0 +1,9 @@ + + + 4.0.0 + com.amazon.sellingpartnerapi + sellingpartnerapi-aa-java + 1.0.3 + POM was created from install:install-file + diff --git a/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/maven-metadata-local.xml b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/maven-metadata-local.xml new file mode 100644 index 00000000..7aa2973a --- /dev/null +++ b/lib/com/amazon/sellingpartnerapi/sellingpartnerapi-aa-java/maven-metadata-local.xml @@ -0,0 +1,12 @@ + + + com.amazon.sellingpartnerapi + sellingpartnerapi-aa-java + + 1.0.3 + + 1.0.3 + + 20230918185406 + + diff --git a/models/catalog-items-api-model/catalogItemsV0.json b/models/catalog-items-api-model/catalogItemsV0.json index 2f2e9f0f..291bc470 100644 --- a/models/catalog-items-api-model/catalogItemsV0.json +++ b/models/catalog-items-api-model/catalogItemsV0.json @@ -27,7 +27,7 @@ "/catalog/v0/items": { "get": { "tags": [ - "catalog" + "catalogV0" ], "description": "Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption. \n_Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.", "operationId": "listCatalogItems", @@ -459,7 +459,7 @@ "/catalog/v0/items/{asin}": { "get": { "tags": [ - "catalog" + "catalogV0" ], "description": "Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption. \n_Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it.", "operationId": "getCatalogItem", @@ -802,7 +802,7 @@ "/catalog/v0/categories": { "get": { "tags": [ - "catalog" + "catalogV0" ], "description": "Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listCatalogCategories", diff --git a/models/catalog-items-api-model/catalogItems_2020-12-01.json b/models/catalog-items-api-model/catalogItems_2020-12-01.json index e0e9e02b..c855c9f4 100644 --- a/models/catalog-items-api-model/catalogItems_2020-12-01.json +++ b/models/catalog-items-api-model/catalogItems_2020-12-01.json @@ -27,7 +27,7 @@ "/catalog/2020-12-01/items": { "get": { "tags": [ - "catalog" + "catalog2020" ], "description": "Search for and return a list of Amazon catalog items and associated information.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchCatalogItems", @@ -585,7 +585,7 @@ "/catalog/2020-12-01/items/{asin}": { "get": { "tags": [ - "catalog" + "catalog2020" ], "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCatalogItem", diff --git a/models/catalog-items-api-model/catalogItems_2022-04-01.json b/models/catalog-items-api-model/catalogItems_2022-04-01.json index 16f3fcdc..b5da09f4 100644 --- a/models/catalog-items-api-model/catalogItems_2022-04-01.json +++ b/models/catalog-items-api-model/catalogItems_2022-04-01.json @@ -27,7 +27,7 @@ "/catalog/2022-04-01/items": { "get": { "tags": [ - "catalog" + "catalog2022" ], "description": "Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.\n\n**Usage Plans:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchCatalogItems", @@ -1636,7 +1636,7 @@ "/catalog/2022-04-01/items/{asin}": { "get": { "tags": [ - "catalog" + "catalog2022" ], "description": "Retrieves details for an item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCatalogItem", diff --git a/models/fba-inbound-eligibility-api-model/fbaInbound.json b/models/fba-inbound-eligibility-api-model/fbaInbound.json index 73577f00..8d0e4af5 100644 --- a/models/fba-inbound-eligibility-api-model/fbaInbound.json +++ b/models/fba-inbound-eligibility-api-model/fbaInbound.json @@ -27,7 +27,7 @@ "/fba/inbound/v1/eligibility/itemPreview": { "get": { "tags": [ - "fbaInbound" + "fbaInboundEligibility" ], "description": "This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getItemEligibilityPreview", diff --git a/models/feeds-api-model/feeds_2020-09-04.json b/models/feeds-api-model/feeds_2020-09-04.json deleted file mode 100644 index 5ed053e3..00000000 --- a/models/feeds-api-model/feeds_2020-09-04.json +++ /dev/null @@ -1,1708 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.", - "version": "2020-09-04", - "title": "Selling Partner API for Feeds", - "contact": { - "name": "Selling Partner API Developer Support", - "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" - }, - "license": { - "name": "Apache License 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "host": "sellingpartnerapi-na.amazon.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/feeds/2020-09-04/feeds": { - "get": { - "tags": [ - "feeds" - ], - "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getFeeds", - "parameters": [ - { - "name": "feedTypes", - "in": "query", - "description": "A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1 - }, - { - "name": "marketplaceIds", - "in": "query", - "description": "A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1 - }, - { - "name": "pageSize", - "in": "query", - "description": "The maximum number of feeds to return in a single call.", - "required": false, - "type": "integer", - "default": 10, - "maximum": 100, - "minimum": 1 - }, - { - "name": "processingStatuses", - "in": "query", - "description": "A list of processing statuses used to filter feeds.", - "required": false, - "type": "array", - "items": { - "type": "string", - "enum": [ - "CANCELLED", - "DONE", - "FATAL", - "IN_PROGRESS", - "IN_QUEUE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "CANCELLED", - "description": "The feed was cancelled before it started processing." - }, - { - "value": "DONE", - "description": "The feed has completed processing. Examine the contents of the result document to determine if there were any errors during processing." - }, - { - "value": "FATAL", - "description": "The feed was aborted due to a fatal error. Some, none or all of the operations within the feed may have completed successfully." - }, - { - "value": "IN_PROGRESS", - "description": "The feed is being processed." - }, - { - "value": "IN_QUEUE", - "description": "The feed has not yet started processing. It may be waiting for another IN_PROGRESS feed." - } - ] - }, - "minItems": 1 - }, - { - "name": "createdSince", - "in": "query", - "description": "The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "createdUntil", - "in": "query", - "description": "The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "nextToken", - "in": "query", - "description": "A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedTypes": { - "value": [ - "POST_PRODUCT_DATA" - ] - }, - "pageSize": { - "value": 10 - }, - "processingStatuses": { - "value": [ - "CANCELLED", - "DONE" - ] - } - } - }, - "response": { - "payload": [ - { - "feedId": "FeedId1", - "feedType": "POST_PRODUCT_DATA", - "createdTime": "2019-12-11T13:16:24.630Z", - "processingStatus": "CANCELLED", - "processingStartTime": "2019-12-11T13:16:24.630Z", - "processingEndTime": "2019-12-11T13:16:24.630Z" - } - ], - "nextToken": "VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA==" - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedTypes": { - "value": [ - "POST_PRODUCT_DATA" - ] - }, - "processingStatuses": { - "value": [ - "BAD_VALUE", - "DONE" - ] - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Dates were not provided" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetFeedsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - }, - "post": { - "tags": [ - "feeds" - ], - "description": "Creates a feed. Encrypt and upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "createFeed", - "parameters": [ - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateFeedSpecification" - } - } - ], - "responses": { - "202": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "feedType": "POST_PRODUCT_DATA", - "marketplaceIds": [ - "ATVPDKIKX0DER", - "A1F83G8C2ARO7P" - ], - "inputFeedDocumentId": "3d4e42b5-1d6e-44e8-a89c-2abfca0625bb" - } - } - } - }, - "response": { - "payload": { - "feedId": "3485934" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "marketplaceIds": [ - "ATVPDKIKX0DER", - "A1F83G8C2ARO7P" - ], - "inputFeedDocumentId": "badDocumentId" - } - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CreateFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - } - }, - "/feeds/2020-09-04/feeds/{feedId}": { - "get": { - "tags": [ - "feeds" - ], - "description": "Returns feed details (including the resultDocumentId, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2.0 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getFeed", - "parameters": [ - { - "name": "feedId", - "in": "path", - "description": "The identifier for the feed. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedId": { - "value": "feedId1" - } - } - }, - "response": { - "payload": { - "feedId": "FeedId1", - "feedType": "POST_PRODUCT_DATA", - "createdTime": "2019-12-11T13:16:24.630Z", - "processingStatus": "CANCELLED", - "processingStartTime": "2019-12-11T13:16:24.630Z", - "processingEndTime": "2019-12-11T13:16:24.630Z" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedId": { - "value": "badFeedId1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - }, - "delete": { - "tags": [ - "feeds" - ], - "description": "Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "cancelFeed", - "parameters": [ - { - "name": "feedId", - "in": "path", - "description": "The identifier for the feed. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedId": { - "value": "ID1" - } - } - }, - "response": {} - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedId": { - "value": "BADID1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CancelFeedResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - } - }, - "/feeds/2020-09-04/documents": { - "post": { - "tags": [ - "feeds" - ], - "description": "Creates a feed document for the feed type that you specify. This operation returns encryption details for encrypting the contents of the document, as well as a presigned URL for uploading the encrypted feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "createFeedDocument", - "parameters": [ - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateFeedDocumentSpecification" - } - } - ], - "responses": { - "201": { - "description": "Successfully created a feed document that is ready to receive contents.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "contentType": "text/tab-separated-values; charset=UTF-8" - } - } - } - }, - "response": { - "payload": { - "feedDocumentId": "3d4e42b5-1d6e-44e8-a89c-2abfca0625bb", - "url": "https://d34o8swod1owfl.cloudfront.net/Feed_101__POST_PRODUCT_DATA_%2BKEY%3DFeed_101%2BMode%3DCBC%2BINITVEC%3D8f+6c+cc+56+0d+50+a2+d0+31+ec+80+be+f2+6a+1d+0a", - "encryptionDetails": { - "standard": "AES", - "initializationVector": "8f 6c cc 56 0d 50 a2 d0 31 ec 80 be f2 6a 1d 0a", - "key": "key" - } - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": {} - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The resource specified does not exist.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "413": { - "description": "The request size exceeded the maximum accepted size.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request payload is in an unsupported format.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CreateFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - } - }, - "/feeds/2020-09-04/documents/{feedDocumentId}": { - "get": { - "tags": [ - "feeds" - ], - "description": "Returns the information required for retrieving a feed document's contents. This includes a presigned URL for the feed document as well as the information required to decrypt the document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getFeedDocument", - "parameters": [ - { - "name": "feedDocumentId", - "in": "path", - "description": "The identifier of the feed document.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedDocumentId": { - "value": "0356cf79-b8b0-4226-b4b9-0ee058ea5760" - } - } - }, - "response": { - "payload": { - "feedDocumentId": "0356cf79-b8b0-4226-b4b9-0ee058ea5760", - "url": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8", - "encryptionDetails": { - "standard": "AES", - "initializationVector": "58 fa bf a7 08 11 95 0f c1 a8 c6 e0 d5 6f ae c8", - "key": "Sample" - } - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "feedDocumentId": { - "value": "badDocumentId1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetFeedDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - } - } - }, - "definitions": { - "Error": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "An error code that identifies the type of error that occurred." - }, - "message": { - "type": "string", - "description": "A message that describes the error condition in a human-readable form." - }, - "details": { - "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." - } - }, - "description": "An error response returned when the request is unsuccessful." - }, - "ErrorList": { - "type": "array", - "description": "A list of error responses returned when a request is unsuccessful.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "CancelFeedResponse": { - "type": "object", - "properties": { - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - }, - "CreateFeedResult": { - "type": "object", - "required": [ - "feedId" - ], - "properties": { - "feedId": { - "type": "string", - "description": "The identifier for the feed. This identifier is unique only in combination with a seller ID." - } - } - }, - "Feed": { - "type": "object", - "required": [ - "createdTime", - "feedId", - "feedType", - "processingStatus" - ], - "properties": { - "feedId": { - "type": "string", - "description": "The identifier for the feed. This identifier is unique only in combination with a seller ID." - }, - "feedType": { - "type": "string", - "description": "The feed type." - }, - "marketplaceIds": { - "type": "array", - "description": "A list of identifiers for the marketplaces that the feed is applied to.", - "items": { - "type": "string" - } - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the feed was created, in ISO 8601 date time format." - }, - "processingStatus": { - "type": "string", - "description": "The processing status of the feed.", - "enum": [ - "CANCELLED", - "DONE", - "FATAL", - "IN_PROGRESS", - "IN_QUEUE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "CANCELLED", - "description": "The feed was cancelled before it started processing." - }, - { - "value": "DONE", - "description": "The feed has completed processing. Examine the contents of the result document to determine if there were any errors during processing." - }, - { - "value": "FATAL", - "description": "The feed was aborted due to a fatal error. Some, none, or all of the operations within the feed may have completed successfully." - }, - { - "value": "IN_PROGRESS", - "description": "The feed is being processed." - }, - { - "value": "IN_QUEUE", - "description": "The feed has not yet started processing. It may be waiting for another IN_PROGRESS feed." - } - ] - }, - "processingStartTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when feed processing started, in ISO 8601 date time format." - }, - "processingEndTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when feed processing completed, in ISO 8601 date time format." - }, - "resultFeedDocumentId": { - "type": "string", - "description": "The identifier for the feed document. This identifier is unique only in combination with a seller ID." - } - } - }, - "FeedList": { - "type": "array", - "items": { - "$ref": "#/definitions/Feed" - } - }, - "GetFeedsResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/FeedList" - }, - "nextToken": { - "type": "string", - "description": "Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds operation with this token as the only parameter." - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - }, - "GetFeedResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/Feed" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - }, - "FeedDocumentEncryptionDetails": { - "type": "object", - "required": [ - "initializationVector", - "key", - "standard" - ], - "properties": { - "standard": { - "type": "string", - "description": "The encryption standard required to encrypt or decrypt the document contents.", - "enum": [ - "AES" - ], - "x-docgen-enum-table-extension": [ - { - "value": "AES", - "description": "The Advanced Encryption Standard (AES)." - } - ] - }, - "initializationVector": { - "type": "string", - "description": "The vector to encrypt or decrypt the document contents using Cipher Block Chaining (CBC)." - }, - "key": { - "type": "string", - "description": "The encryption key used to encrypt or decrypt the document contents." - } - }, - "description": "Encryption details for required client-side encryption and decryption of document contents." - }, - "FeedDocument": { - "type": "object", - "required": [ - "encryptionDetails", - "feedDocumentId", - "url" - ], - "properties": { - "feedDocumentId": { - "type": "string", - "description": "The identifier for the feed document. This identifier is unique only in combination with a seller ID." - }, - "url": { - "type": "string", - "description": "A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can download the feed directly from this URL. This URL expires after 5 minutes." - }, - "encryptionDetails": { - "$ref": "#/definitions/FeedDocumentEncryptionDetails" - }, - "compressionAlgorithm": { - "type": "string", - "description": "If the feed document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the feed when you download. Otherwise, you can download the feed directly. Refer to [Step 6. Download and decrypt the feed processing report](doc:feeds-api-v2020-09-04-use-case-guide#step-6-download-and-decrypt-the-feed-processing-report) in the use case guide, where sample code is provided.", - "enum": [ - "GZIP" - ], - "x-docgen-enum-table-extension": [ - { - "value": "GZIP", - "description": "The gzip compression algorithm." - } - ] - } - } - }, - "GetFeedDocumentResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/FeedDocument" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - }, - "CreateFeedResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/CreateFeedResult" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - }, - "FeedOptions": { - "type": "object", - "description": "Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in [feedType values](https://github.com/amzn/selling-partner-api-docs/blob/main/references/feeds-api/feedtype-values.md).", - "additionalProperties": { - "type": "string" - } - }, - "CreateFeedSpecification": { - "type": "object", - "required": [ - "feedType", - "inputFeedDocumentId", - "marketplaceIds" - ], - "properties": { - "feedType": { - "type": "string", - "description": "The feed type." - }, - "marketplaceIds": { - "type": "array", - "description": "A list of identifiers for marketplaces that you want the feed to be applied to.", - "items": { - "type": "string" - }, - "maxItems": 25, - "minItems": 1 - }, - "inputFeedDocumentId": { - "type": "string", - "description": "The document identifier returned by the createFeedDocument operation. Encrypt and upload the feed document contents before calling the createFeed operation." - }, - "feedOptions": { - "$ref": "#/definitions/FeedOptions" - } - } - }, - "CreateFeedDocumentSpecification": { - "type": "object", - "required": [ - "contentType" - ], - "properties": { - "contentType": { - "type": "string", - "description": "The content type of the feed." - } - } - }, - "CreateFeedDocumentResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/CreateFeedDocumentResult" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the createFeedDocument operation." - }, - "CreateFeedDocumentResult": { - "type": "object", - "required": [ - "encryptionDetails", - "feedDocumentId", - "url" - ], - "properties": { - "feedDocumentId": { - "type": "string", - "description": "The identifier of the feed document." - }, - "url": { - "type": "string", - "description": "The presigned URL for uploading the feed contents. This URL expires after 5 minutes." - }, - "encryptionDetails": { - "$ref": "#/definitions/FeedDocumentEncryptionDetails" - } - }, - "description": "Information required to encrypt and upload a feed document's contents." - } - } -} \ No newline at end of file diff --git a/models/feeds-api-model/feeds_2021-06-30.json b/models/feeds-api-model/feeds_2021-06-30.json index 1c241971..e0ff4ea3 100644 --- a/models/feeds-api-model/feeds_2021-06-30.json +++ b/models/feeds-api-model/feeds_2021-06-30.json @@ -27,7 +27,7 @@ "/feeds/2021-06-30/feeds": { "get": { "tags": [ - "feeds" + "feeds2021" ], "description": "Returns feed details for the feeds that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeeds", @@ -342,7 +342,7 @@ }, "post": { "tags": [ - "feeds" + "feeds2021" ], "description": "Creates a feed. Upload the contents of the feed document before calling this operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0083 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFeed", @@ -555,7 +555,7 @@ "/feeds/2021-06-30/feeds/{feedId}": { "delete": { "tags": [ - "feeds" + "feeds2021" ], "description": "Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelFeed", @@ -745,7 +745,7 @@ }, "get": { "tags": [ - "feeds" + "feeds2021" ], "description": "Returns feed details (including the resultDocumentId, if available) for the feed that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeed", @@ -951,7 +951,7 @@ "description": "Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createFeedDocument", "tags": [ - "feeds" + "feeds2021" ], "parameters": [ { @@ -1152,7 +1152,7 @@ "/feeds/2021-06-30/documents/{feedDocumentId}": { "get": { "tags": [ - "feeds" + "feeds2021" ], "description": "Returns the information required for retrieving a feed document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getFeedDocument", diff --git a/models/listings-items-api-model/listingsItems_2020-09-01.json b/models/listings-items-api-model/listingsItems_2020-09-01.json index fa3540f4..e69de29b 100644 --- a/models/listings-items-api-model/listingsItems_2020-09-01.json +++ b/models/listings-items-api-model/listingsItems_2020-09-01.json @@ -1,953 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.\n\nFor more information, see the [Listing Items API Use Case Guide](doc:listings-items-api-v2020-09-01-use-case-guide).", - "version": "2020-09-01", - "title": "Selling Partner API for Listings Items", - "contact": { - "name": "Selling Partner API Developer Support", - "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" - }, - "license": { - "name": "Apache License 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "host": "sellingpartnerapi-na.amazon.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/listings/2020-09-01/items/{sellerId}/{sku}": { - "delete": { - "tags": [ - "listings" - ], - "description": "Delete a listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", - "operationId": "deleteListingsItem", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "sellerId", - "description": "A selling partner identifier, such as a merchant account or vendor code.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "sku", - "description": "A selling partner provided identifier for an Amazon listing.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "marketplaceIds", - "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "csv", - "x-example": "ATVPDKIKX0DER" - }, - { - "name": "issueLocale", - "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", - "in": "query", - "required": false, - "type": "string", - "x-example": "en_US" - } - ], - "responses": { - "200": { - "description": "Successfully understood the listings item delete request. See the response to determine whether the submission has been accepted.", - "schema": { - "$ref": "#/definitions/ListingsItemSubmissionResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "examples": { - "application/json": { - "sku":"GM-ZDPI-9B4E", - "status":"ACCEPTED", - "submissionId":"f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues":[] - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - } - }, - "response": { - "sku": "GM-ZDPI-9B4E", - "status": "ACCEPTED", - "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues": [] - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "sku": { - "value": "BadSKU" - } - } - }, - "response": { - "errors": [ - { - "code": "BAD_REQUEST", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "headers": { - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "413": { - "description": "The request size exceeded the maximum accepted size.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "415": { - "description": "The request payload is in an unsupported format.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - } - } - }, - "patch": { - "tags": [ - "listings" - ], - "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", - "operationId": "patchListingsItem", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "sellerId", - "description": "A selling partner identifier, such as a merchant account or vendor code.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "sku", - "description": "A selling partner provided identifier for an Amazon listing.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "marketplaceIds", - "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "csv", - "x-example": "ATVPDKIKX0DER" - }, - { - "name": "issueLocale", - "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", - "in": "query", - "required": false, - "type": "string", - "x-example": "en_US" - }, - { - "name": "body", - "description": "The request body schema for the patchListingsItem operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ListingsItemPatchRequest" - } - } - ], - "responses": { - "200": { - "description": "Successfully understood the listings item patch request. See the response to determine if the submission was accepted.", - "schema": { - "$ref": "#/definitions/ListingsItemSubmissionResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "examples": { - "application/json": { - "sku": "GM-ZDPI-9B4E", - "status": "ACCEPTED", - "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues": [] - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - } - } - }, - "response": { - "sku": "GM-ZDPI-9B4E", - "status": "ACCEPTED", - "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues": [] - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "sku": { - "value": "BadSKU" - } - } - }, - "response": { - "errors": [ - { - "code": "BAD_REQUEST", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "headers": { - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "413": { - "description": "The request size exceeded the maximum accepted size.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "415": { - "description": "The request payload is in an unsupported format.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - } - } - }, - "put": { - "tags": [ - "listings" - ], - "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).", - "operationId": "putListingsItem", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "sellerId", - "description": "A selling partner identifier, such as a merchant account or vendor code.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "sku", - "description": "A selling partner provided identifier for an Amazon listing.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "marketplaceIds", - "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "csv", - "x-example": "ATVPDKIKX0DER" - }, - { - "name": "issueLocale", - "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", - "in": "query", - "required": false, - "type": "string", - "x-example": "en_US" - }, - { - "name": "body", - "description": "The request body schema for the putListingsItem operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ListingsItemPutRequest" - } - } - ], - "responses": { - "200": { - "description": "Successfully understood the request to create or fully-update a listings item. See the response to determine if the submission has been accepted.", - "schema": { - "$ref": "#/definitions/ListingsItemSubmissionResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "examples": { - "application/json": { - "sku": "GM-ZDPI-9B4E", - "status": "ACCEPTED", - "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues": [] - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - } - } - }, - "response": { - "sku": "GM-ZDPI-9B4E", - "status": "ACCEPTED", - "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", - "issues": [] - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "sku": { - "value": "BadSKU" - } - } - }, - "response": { - "errors": [ - { - "code": "BAD_REQUEST", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "headers": { - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "413": { - "description": "The request size exceeded the maximum accepted size.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "415": { - "description": "The request payload is in an unsupported format.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "description": "Unique request reference identifier.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ErrorList" - } - } - } - } - } - }, - "definitions": { - "Error": { - "description": "Error response returned when the request is unsuccessful.", - "properties": { - "code": { - "description": "An error code that identifies the type of error that occurred.", - "type": "string" - }, - "message": { - "description": "A message that describes the error condition.", - "type": "string" - }, - "details": { - "description": "Additional details that can help the caller understand or fix the issue.", - "type": "string" - } - }, - "required": [ - "code", - "message" - ], - "type": "object" - }, - "ErrorList": { - "description": "A list of error responses returned when a request is unsuccessful.", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/Error" - } - } - }, - "required": [ - "errors" - ] - }, - "Issue": { - "description": "An issue with a listings item.", - "properties": { - "code": { - "description": "An issue code that identifies the type of issue.", - "type": "string" - }, - "message": { - "description": "A message that describes the issue.", - "type": "string" - }, - "severity": { - "description": "The severity of the issue.", - "enum": [ - "ERROR", - "WARNING", - "INFO" - ], - "x-docgen-enum-table-extension": [ - { - "value": "ERROR", - "description": "Indicates an issue has occurred preventing the submission from processing, such as a validation error." - }, - { - "value": "WARNING", - "description": "Indicates an issue has occurred that should be reviewed, but has not prevented the submission from processing." - }, - { - "value": "INFO", - "description": "Indicates additional information has been provided that should be reviewed." - } - ], - "type": "string" - }, - "attributeName": { - "description": "Name of the attribute associated with the issue, if applicable.", - "type": "string" - } - }, - "required": [ - "code", - "message", - "severity" - ], - "type": "object" - }, - "PatchOperation": { - "description": "Individual JSON Patch operation for an HTTP PATCH request.", - "properties": { - "op": { - "description": "Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. See .", - "enum": [ - "add", - "replace", - "delete" - ], - "x-docgen-enum-table-extension": [ - { - "value": "add", - "description": "The \"add\" operation adds or replaces the target property." - }, - { - "value": "replace", - "description": "The \"replace\" operation adds or replaces the target property." - }, - { - "value": "delete", - "description": "The \"delete\" operation removes the target property. Not supported for vendors (vendors will receive an HTTP status code 400 response)." - } - ], - "type": "string" - }, - "path": { - "description": "JSON Pointer path of the element to patch. See .", - "type": "string" - }, - "value": { - "description": "JSON value to add, replace, or delete.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - }, - "required": [ - "op", - "path" - ], - "type": "object" - }, - "ListingsItemPatchRequest": { - "description": "The request body schema for the patchListingsItem operation.", - "properties": { - "productType": { - "description": "The Amazon product type of the listings item.", - "type": "string" - }, - "patches": { - "description": "One or more JSON Patch operations to perform on the listings item.", - "type": "array", - "items": { - "$ref": "#/definitions/PatchOperation" - }, - "minItems": 1 - } - }, - "required": [ - "productType", - "patches" - ], - "type": "object" - }, - "ListingsItemPutRequest": { - "description": "The request body schema for the putListingsItem operation.", - "properties": { - "productType": { - "description": "The Amazon product type of the listings item.", - "type": "string" - }, - "requirements": { - "description": "The name of the requirements set for the provided data.", - "enum": [ - "LISTING", - "LISTING_PRODUCT_ONLY", - "LISTING_OFFER_ONLY" - ], - "x-docgen-enum-table-extension": [ - { - "value": "LISTING", - "description": "Indicates the submitted data contains product facts and sales terms." - }, - { - "value": "LISTING_PRODUCT_ONLY", - "description": "Indicates the submitted data contains product facts only." - }, - { - "value": "LISTING_OFFER_ONLY", - "description": "Indicates the submitted data contains sales terms only.Not supported for vendors (vendors will receive an HTTP status code 400 response)." - } - ], - "type": "string" - }, - "attributes": { - "description": "JSON object containing structured listings item attribute data keyed by attribute name.", - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "productType", - "attributes" - ], - "type": "object" - }, - "ListingsItemSubmissionResponse": { - "description": "Response containing the results of a submission to the Selling Partner API for Listings Items.", - "properties": { - "sku": { - "description": "A selling partner provided identifier for an Amazon listing.", - "type": "string" - }, - "status": { - "description": "The status of the listings item submission.", - "enum": [ - "ACCEPTED", - "INVALID" - ], - "x-docgen-enum-table-extension": [ - { - "value": "ACCEPTED", - "description": "The listings submission was accepted for processing." - }, - { - "value": "INVALID", - "description": "The listings submission was not valid and was not accepted for processing." - } - ], - "type": "string" - }, - "submissionId": { - "description": "The unique identifier of the listings item submission.", - "type": "string" - }, - "issues": { - "description": "Listings item issues related to the listings item submission.", - "type": "array", - "items": { - "$ref": "#/definitions/Issue" - } - } - }, - "required": [ - "sku", - "status", - "submissionId" - ], - "type": "object" - } - } -} \ No newline at end of file diff --git a/models/reports-api-model/reports_2020-09-04.json b/models/reports-api-model/reports_2020-09-04.json deleted file mode 100644 index 543d87b7..00000000 --- a/models/reports-api-model/reports_2020-09-04.json +++ /dev/null @@ -1,2538 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses.", - "version": "2020-09-04", - "title": "Selling Partner API for Reports", - "contact": { - "name": "Selling Partner API Developer Support", - "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" - }, - "license": { - "name": "Apache License 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "host": "sellingpartnerapi-na.amazon.com", - "basePath": "/", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/reports/2020-09-04/reports": { - "get": { - "tags": [ - "reports" - ], - "description": "Returns report details for the reports that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getReports", - "parameters": [ - { - "name": "reportTypes", - "in": "query", - "description": "A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1 - }, - { - "name": "processingStatuses", - "in": "query", - "description": "A list of processing statuses used to filter reports.", - "required": false, - "type": "array", - "items": { - "type": "string", - "enum": [ - "CANCELLED", - "DONE", - "FATAL", - "IN_PROGRESS", - "IN_QUEUE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "CANCELLED", - "description": "The report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return." - }, - { - "value": "DONE", - "description": "The report has completed processing." - }, - { - "value": "FATAL", - "description": "The report was aborted due to a fatal error." - }, - { - "value": "IN_PROGRESS", - "description": "The report is being processed." - }, - { - "value": "IN_QUEUE", - "description": "The report has not yet started processing. It may be waiting for another IN_PROGRESS report." - } - ] - }, - "minItems": 1 - }, - { - "name": "marketplaceIds", - "in": "query", - "description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1 - }, - { - "name": "pageSize", - "in": "query", - "description": "The maximum number of reports to return in a single call.", - "required": false, - "type": "integer", - "default": 10, - "maximum": 100, - "minimum": 1 - }, - { - "name": "createdSince", - "in": "query", - "description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "createdUntil", - "in": "query", - "description": "The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "nextToken", - "in": "query", - "description": "A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportTypes": { - "value": [ - "FEE_DISCOUNTS_REPORT", - "GET_AFN_INVENTORY_DATA" - ] - }, - "processingStatuses": { - "value": [ - "IN_QUEUE", - "IN_PROGRESS" - ] - } - } - }, - "response": { - "nextToken": "VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA==", - "payload": [ - { - "reportId": "ReportId1", - "reportType": "FEE_DISCOUNTS_REPORT", - "dataStartTime": "2019-12-11T13:47:20.677Z", - "dataEndTime": "2019-12-12T13:47:20.677Z", - "createdTime": "2019-12-10T13:47:20.677Z", - "processingStatus": "IN_PROGRESS", - "processingStartTime": "2019-12-10T13:47:20.677Z", - "processingEndTime": "2019-12-12T13:47:20.677Z" - } - ] - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportTypes": { - "value": [ - "FEE_DISCOUNTS_REPORT", - "GET_AFN_INVENTORY_DATA" - ] - }, - "processingStatuses": { - "value": [ - "BAD_VALUE", - "IN_PROGRESS" - ] - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input in processing status" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetReportsResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, - "post": { - "tags": [ - "reports" - ], - "description": "Creates a report.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "createReport", - "parameters": [ - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateReportSpecification" - } - } - ], - "responses": { - "202": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "reportType": "GET_MERCHANT_LISTINGS_ALL_DATA", - "dataStartTime": "2019-12-10T20:11:24.000Z", - "marketplaceIds": [ - "A1PA6795UKMFR9", - "ATVPDKIKX0DER" - ] - } - } - } - }, - "response": { - "payload": { - "reportId": "ID323" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "reportType": "BAD_FEE_DISCOUNTS_REPORT", - "dataStartTime": "2019-12-10T20:11:24.000Z", - "marketplaceIds": [ - "A1PA6795UKMFR9", - "ATVPDKIKX0DER" - ] - } - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CreateReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - } - }, - "/reports/2020-09-04/reports/{reportId}": { - "get": { - "tags": [ - "reports" - ], - "description": "Returns report details (including the reportDocumentId, if available) for the report that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2.0 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getReport", - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportId": { - "value": "ID323" - } - } - }, - "response": { - "payload": { - "reportId": "ReportId1", - "reportType": "FEE_DISCOUNTS_REPORT", - "dataStartTime": "2019-12-11T13:47:20.677Z", - "dataEndTime": "2019-12-12T13:47:20.677Z", - "createdTime": "2019-12-10T13:47:20.677Z", - "processingStatus": "IN_PROGRESS", - "processingStartTime": "2019-12-10T13:47:20.677Z", - "processingEndTime": "2019-12-12T13:47:20.677Z" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportId": { - "value": "badReportId1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, - "delete": { - "tags": [ - "reports" - ], - "description": "Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "cancelReport", - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportId": { - "value": "ID" - } - } - }, - "response": {} - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": {} - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - } - }, - "/reports/2020-09-04/schedules": { - "get": { - "tags": [ - "reports" - ], - "description": "Returns report schedule details that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getReportSchedules", - "parameters": [ - { - "name": "reportTypes", - "in": "query", - "description": "A list of report types used to filter report schedules.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 10, - "minItems": 1 - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportTypes": { - "value": [ - "FEE_DISCOUNTS_REPORT", - "GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA" - ] - } - } - }, - "response": { - "payload": [ - { - "reportType": "FEE_DISCOUNTS_REPORT", - "marketplaceIds": [ - "ATVPDKIKX0DER" - ], - "reportScheduleId": "ID1", - "period": "PT5M", - "nextReportCreationTime": "2019-12-11T15:03:44.973Z" - }, - { - "reportType": "GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA", - "reportScheduleId": "ID2", - "period": "PT5M", - "nextReportCreationTime": "2019-12-11T15:03:44.973Z" - } - ] - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportTypes": { - "value": [ - "BAD_FEE_DISCOUNTS_REPORT", - "BAD_GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA" - ] - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetReportSchedulesResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, - "post": { - "tags": [ - "reports" - ], - "description": "Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "createReportSchedule", - "parameters": [ - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateReportScheduleSpecification" - } - } - ], - "responses": { - "201": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "reportType": "FEE_DISCOUNTS_REPORT", - "period": "PT5M", - "nextReportCreationTime": "2019-12-10T20:11:24.000Z", - "marketplaceIds": [ - "A1PA6795UKMFR9", - "ATVPDKIKX0DER" - ] - } - } - } - }, - "response": { - "payload": { - "reportScheduleId": "ID323" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "body": { - "value": { - "reportType": "BAD_FEE_DISCOUNTS_REPORT", - "period": "PT5M", - "nextReportCreationTime": "2019-12-10T20:11:24.000Z" - } - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CreateReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - } - }, - "/reports/2020-09-04/schedules/{reportScheduleId}": { - "get": { - "tags": [ - "reports" - ], - "description": "Returns report schedule details for the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getReportSchedule", - "parameters": [ - { - "name": "reportScheduleId", - "in": "path", - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportScheduleId": { - "value": "ID323" - } - } - }, - "response": { - "payload": { - "reportScheduleId": "ReportScheduleId1", - "reportType": "FEE_DISCOUNTS_REPORT", - "period": "PT5M", - "nextReportCreationTime": "2019-12-12T13:47:20.677Z" - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportScheduleId": { - "value": "badReportId1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, - "delete": { - "tags": [ - "reports" - ], - "description": "Cancels the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "cancelReportSchedule", - "parameters": [ - { - "name": "reportScheduleId", - "in": "path", - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportScheduleId": { - "value": "ID" - } - } - }, - "response": {} - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": {} - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - } - }, - "/reports/2020-09-04/documents/{reportDocumentId}": { - "get": { - "tags": [ - "reports" - ], - "description": "Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "operationId": "getReportDocument", - "parameters": [ - { - "name": "reportDocumentId", - "in": "path", - "description": "The identifier for the report document.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportDocumentId": { - "value": "0356cf79-b8b0-4226-b4b9-0ee058ea5760" - } - } - }, - "response": { - "payload": { - "reportDocumentId": "0356cf79-b8b0-4226-b4b9-0ee058ea5760", - "url": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8", - "encryptionDetails": { - "standard": "AES", - "initializationVector": "58 fa bf a7 08 11 95 0f c1 a8 c6 e0 d5 6f ae c8", - "key": "Sample" - } - } - } - } - ] - } - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - }, - "x-amzn-api-sandbox": { - "static": [ - { - "request": { - "parameters": { - "reportDocumentId": { - "value": "badDocumentId1" - } - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - } - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/GetReportDocumentResponse" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "type": "string", - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - } - } - } - } - }, - "definitions": { - "ErrorList": { - "type": "array", - "description": "A list of error responses returned when a request is unsuccessful.", - "items": { - "$ref": "#/definitions/Error" - } - }, - "Error": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "An error code that identifies the type of error that occurred." - }, - "message": { - "type": "string", - "description": "A message that describes the error condition in a human-readable form." - }, - "details": { - "type": "string", - "description": "Additional details that can help the caller understand or fix the issue." - } - }, - "description": "Error response returned when the request is unsuccessful." - }, - "ReportDocumentEncryptionDetails": { - "type": "object", - "required": [ - "initializationVector", - "key", - "standard" - ], - "properties": { - "standard": { - "type": "string", - "description": "The encryption standard required to decrypt the document contents.", - "enum": [ - "AES" - ], - "x-docgen-enum-table-extension": [ - { - "value": "AES", - "description": "The Advanced Encryption Standard (AES)." - } - ] - }, - "initializationVector": { - "type": "string", - "description": "The vector to decrypt the document contents using Cipher Block Chaining (CBC)." - }, - "key": { - "type": "string", - "description": "The encryption key used to decrypt the document contents." - } - }, - "description": "Encryption details required for decryption of a report document's contents." - }, - "Report": { - "type": "object", - "required": [ - "createdTime", - "processingStatus", - "reportId", - "reportType" - ], - "properties": { - "marketplaceIds": { - "type": "array", - "description": "A list of marketplace identifiers for the report.", - "items": { - "type": "string" - } - }, - "reportId": { - "type": "string", - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." - }, - "reportType": { - "type": "string", - "description": "The report type." - }, - "dataStartTime": { - "type": "string", - "format": "date-time", - "description": "The start of a date and time range used for selecting the data to report." - }, - "dataEndTime": { - "type": "string", - "format": "date-time", - "description": "The end of a date and time range used for selecting the data to report." - }, - "reportScheduleId": { - "type": "string", - "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the report was created." - }, - "processingStatus": { - "type": "string", - "description": "The processing status of the report.", - "enum": [ - "CANCELLED", - "DONE", - "FATAL", - "IN_PROGRESS", - "IN_QUEUE" - ], - "x-docgen-enum-table-extension": [ - { - "value": "CANCELLED", - "description": "The report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return." - }, - { - "value": "DONE", - "description": "The report has completed processing." - }, - { - "value": "FATAL", - "description": "The report was aborted due to a fatal error." - }, - { - "value": "IN_PROGRESS", - "description": "The report is being processed." - }, - { - "value": "IN_QUEUE", - "description": "The report has not yet started processing. It may be waiting for another IN_PROGRESS report." - } - ] - }, - "processingStartTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the report processing started, in ISO 8601 date time format." - }, - "processingEndTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the report processing completed, in ISO 8601 date time format." - }, - "reportDocumentId": { - "type": "string", - "description": "The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents." - } - } - }, - "ReportList": { - "type": "array", - "items": { - "$ref": "#/definitions/Report" - } - }, - "CreateReportScheduleSpecification": { - "type": "object", - "required": [ - "marketplaceIds", - "period", - "reportType" - ], - "properties": { - "reportType": { - "type": "string", - "description": "The report type." - }, - "marketplaceIds": { - "type": "array", - "description": "A list of marketplace identifiers for the report schedule.", - "items": { - "type": "string" - }, - "maxItems": 25, - "minItems": 1 - }, - "reportOptions": { - "$ref": "#/definitions/ReportOptions" - }, - "period": { - "type": "string", - "description": "One of a set of predefined ISO 8601 periods that specifies how often a report should be created.", - "enum": [ - "PT5M", - "PT15M", - "PT30M", - "PT1H", - "PT2H", - "PT4H", - "PT8H", - "PT12H", - "P1D", - "P2D", - "P3D", - "PT84H", - "P7D", - "P14D", - "P15D", - "P18D", - "P30D", - "P1M" - ], - "x-docgen-enum-table-extension": [ - { - "value": "PT5M", - "description": "5 minutes" - }, - { - "value": "PT15M", - "description": "15 minutes" - }, - { - "value": "PT30M", - "description": "30 minutes" - }, - { - "value": "PT1H", - "description": "1 hour" - }, - { - "value": "PT2H", - "description": "2 hours" - }, - { - "value": "PT4H", - "description": "4 hours" - }, - { - "value": "PT8H", - "description": "8 hours" - }, - { - "value": "PT12H", - "description": "12 hours" - }, - { - "value": "P1D", - "description": "1 day" - }, - { - "value": "P2D", - "description": "2 days" - }, - { - "value": "P3D", - "description": "3 days" - }, - { - "value": "PT84H", - "description": "84 hours" - }, - { - "value": "P7D", - "description": "7 days" - }, - { - "value": "P14D", - "description": "14 days" - }, - { - "value": "P15D", - "description": "15 days" - }, - { - "value": "P18D", - "description": "18 days" - }, - { - "value": "P30D", - "description": "30 days" - }, - { - "value": "P1M", - "description": "1 month" - } - ] - }, - "nextReportCreationTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." - } - } - }, - "CreateReportSpecification": { - "type": "object", - "required": [ - "marketplaceIds", - "reportType" - ], - "properties": { - "reportOptions": { - "$ref": "#/definitions/ReportOptions" - }, - "reportType": { - "type": "string", - "description": "The report type." - }, - "dataStartTime": { - "type": "string", - "format": "date-time", - "description": "The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." - }, - "dataEndTime": { - "type": "string", - "format": "date-time", - "description": "The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." - }, - "marketplaceIds": { - "type": "array", - "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", - "items": { - "type": "string" - }, - "maxItems": 25, - "minItems": 1 - } - } - }, - "ReportOptions": { - "type": "object", - "description": "Additional information passed to reports. This varies by report type.", - "additionalProperties": { - "type": "string" - } - }, - "ReportSchedule": { - "type": "object", - "required": [ - "period", - "reportScheduleId", - "reportType" - ], - "properties": { - "reportScheduleId": { - "type": "string", - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." - }, - "reportType": { - "type": "string", - "description": "The report type." - }, - "marketplaceIds": { - "type": "array", - "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", - "items": { - "type": "string" - } - }, - "reportOptions": { - "$ref": "#/definitions/ReportOptions" - }, - "period": { - "type": "string", - "description": "An ISO 8601 period value that indicates how often a report should be created." - }, - "nextReportCreationTime": { - "type": "string", - "format": "date-time", - "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." - } - }, - "description": "Detailed information about a report schedule." - }, - "ReportScheduleList": { - "type": "array", - "items": { - "$ref": "#/definitions/ReportSchedule" - } - }, - "CreateReportResult": { - "type": "object", - "required": [ - "reportId" - ], - "properties": { - "reportId": { - "type": "string", - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." - } - } - }, - "GetReportsResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the getReports operation.", - "$ref": "#/definitions/ReportList" - }, - "nextToken": { - "type": "string", - "description": "Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter." - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the getReports operation." - }, - "CreateReportResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the createReport operation.", - "$ref": "#/definitions/CreateReportResult" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the createReport operation." - }, - "CancelReportResponse": { - "type": "object", - "properties": { - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the cancelReport operation." - }, - "CancelReportScheduleResponse": { - "type": "object", - "properties": { - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the cancelReportSchedule operation." - }, - "GetReportResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the getReport operation.", - "$ref": "#/definitions/Report" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the getReport operation." - }, - "GetReportSchedulesResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the getReportSchedules operation.", - "$ref": "#/definitions/ReportScheduleList" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the getReportSchedules operation." - }, - "GetReportScheduleResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the getReportSchedule operation.", - "$ref": "#/definitions/ReportSchedule" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the getReportSchedule operation." - }, - "CreateReportScheduleResult": { - "type": "object", - "required": [ - "reportScheduleId" - ], - "properties": { - "reportScheduleId": { - "type": "string", - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." - } - } - }, - "CreateReportScheduleResponse": { - "type": "object", - "properties": { - "payload": { - "description": "The payload for the createReportSchedule operation.", - "$ref": "#/definitions/CreateReportScheduleResult" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "The response for the createReportSchedule operation." - }, - "ReportDocument": { - "type": "object", - "required": [ - "encryptionDetails", - "reportDocumentId", - "url" - ], - "properties": { - "reportDocumentId": { - "type": "string", - "description": "The identifier for the report document. This identifier is unique only in combination with a seller ID." - }, - "url": { - "type": "string", - "description": "A presigned URL for the report document. If `compressionAlgorithm` is not returned, you can download the report directly from this URL. This URL expires after 5 minutes." - }, - "encryptionDetails": { - "$ref": "#/definitions/ReportDocumentEncryptionDetails" - }, - "compressionAlgorithm": { - "type": "string", - "description": "If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to [Step 2. Download and decrypt the report](doc:reports-api-v2020-09-04-use-case-guide#step-2-download-and-decrypt-the-report) in the use case guide, where sample code is provided.", - "enum": [ - "GZIP" - ], - "x-docgen-enum-table-extension": [ - { - "value": "GZIP", - "description": "The gzip compression algorithm." - } - ] - } - } - }, - "GetReportDocumentResponse": { - "type": "object", - "properties": { - "payload": { - "$ref": "#/definitions/ReportDocument" - }, - "errors": { - "$ref": "#/definitions/ErrorList" - } - }, - "description": "Response schema." - } - } -} \ No newline at end of file diff --git a/models/reports-api-model/reports_2021-06-30.json b/models/reports-api-model/reports_2021-06-30.json index d720797f..3ac27671 100644 --- a/models/reports-api-model/reports_2021-06-30.json +++ b/models/reports-api-model/reports_2021-06-30.json @@ -27,7 +27,7 @@ "/reports/2021-06-30/reports": { "get": { "tags": [ - "reports" + "reports2021" ], "operationId": "getReports", "description": "Returns report details for the reports that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", @@ -343,7 +343,7 @@ }, "post": { "tags": [ - "reports" + "reports2021" ], "operationId": "createReport", "description": "Creates a report.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", @@ -557,7 +557,7 @@ "/reports/2021-06-30/reports/{reportId}": { "delete": { "tags": [ - "reports" + "reports2021" ], "operationId": "cancelReport", "description": "Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", @@ -743,7 +743,7 @@ }, "get": { "tags": [ - "reports" + "reports2021" ], "operationId": "getReport", "description": "Returns report details (including the reportDocumentId, if available) for the report that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2.0 | 15 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", @@ -949,7 +949,7 @@ "/reports/2021-06-30/schedules": { "get": { "tags": [ - "reports" + "reports2021" ], "operationId": "getReportSchedules", "description": "Returns report schedule details that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", @@ -1172,7 +1172,7 @@ }, "post": { "tags": [ - "reports" + "reports2021" ], "operationId": "createReportSchedule", "description": "Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", @@ -1384,7 +1384,7 @@ "/reports/2021-06-30/schedules/{reportScheduleId}": { "delete": { "tags": [ - "reports" + "reports2021" ], "operationId": "cancelReportSchedule", "description": "Cancels the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", @@ -1570,7 +1570,7 @@ }, "get": { "tags": [ - "reports" + "reports2021" ], "operationId": "getReportSchedule", "description": "Returns report schedule details for the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.", @@ -1772,7 +1772,7 @@ "/reports/2021-06-30/documents/{reportDocumentId}": { "get": { "tags": [ - "reports" + "reports2021" ], "description": "Returns the information required for retrieving a report document's contents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nFor more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api)in the Selling Partner API documentation.", "operationId": "getReportDocument", diff --git a/models/shipping-api-model/shipping2.json b/models/shipping-api-model/shipping2.json new file mode 100644 index 00000000..62e22ee9 --- /dev/null +++ b/models/shipping-api-model/shipping2.json @@ -0,0 +1,4142 @@ +{ + "swagger": "2.0", + "info": { + "description": "The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.", + "version": "v2", + "title": "Amazon Shipping API", + "contact": { + "name": "Amazon Shipping API Support", + "email": "swa-api-core@amazon.com" + }, + "license": { + "name": "Amazon Software License", + "url": "https://aws.amazon.com/asl/" + } + }, + "host": "sellingpartnerapi-eu.amazon.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/shipping/v2/shipments/rates": { + "post": { + "tags": [ + "shipping" + ], + "description": "Returns the available shipping service offerings.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getRates", + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetRatesRequest" + } + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetRatesResponse" + }, + "examples": { + "application/json": { + "requestToken": "6DCCEDD3FF961C15FEB94F342D41C", + "rates": [ + { + "rateId": "F4B68849F969E239FF9FCA9C12E35", + "carrierId": "FOOSHIPGRD", + "carrierName": "FOO SHIP GRD", + "billedWeight": { + "value": 5, + "unit": "GRAMS" + }, + "totalCharge": { + "value": 7, + "unit": "USD" + }, + "serviceId": "FOORSID", + "serviceName": "FOO RS ID", + "promise": { + "deliveryWindow": { + "start": "2018-08-24T08:22:30.737Z", + "end": "2018-08-24T20:22:30.737Z" + }, + "pickupWindow": { + "start": "2018-08-23T08:22:30.737Z", + "end": "2018-08-23T20:22:30.737Z" + } + }, + "supportedDocumentSpecifications": [ + { + "format": "PNG", + "size": { + "length": 6, + "width": 4, + "unit": "INCH" + }, + "printOptions": [ + { + "supportedDPIs": [ + 300, + 203 + ], + "supportedPageLayouts": [ + "LEFT", + "RIGHT" + ], + "supportedFileJoiningOptions": [ + true, + false + ], + "supportedDocumentDetails": [ + { + "name": "LABEL", + "isMandatory": true + } + ] + } + ] + }, + { + "format": "ZPL", + "size": { + "length": 6, + "width": 4, + "unit": "INCH" + }, + "printOptions": [ + { + "supportedDPIs": [ + 300, + 203 + ], + "supportedPageLayouts": [ + "LEFT", + "RIGHT" + ], + "supportedFileJoiningOptions": [ + true, + false + ], + "supportedDocumentDetails": [ + { + "name": "LABEL", + "isMandatory": true + } + ] + } + ] + } + ], + "availableValueAddedServiceGroups": [ + { + "groupId": "SIG_VERIFICATION", + "groupDescription": "Signature Verification", + "isRequired": true, + "valueAddedServices": [ + { + "id": "CUST_SIG_VERIFICATION", + "name": "Customer Signature Verification", + "cost": { + "unit": "USD", + "value": 2 + } + } + ] + } + ], + "requiresAdditionalInputs": false + } + ], + "ineligibleRates": [ + { + "carrierId": "FOOSTDGRD", + "serviceId": "FOO8420430", + "carrierName": "FOOSTDGRD", + "serviceName": "FOO8420430", + "ineligibilityReasons": [ + { + "code": "NO_COVERAGE", + "message": "Required shipping network coverage doesn't exist for the offering" + } + ] + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "ChannelDetails object cannot be null" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + }, + "x-amzn-api-sandbox": { + "dynamic": {} + } + }, + "parameters": [] + }, + "/shipping/v2/shipments/directPurchase": { + "post": { + "tags": [ + "shipping" + ], + "description": "Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "directPurchaseShipment", + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DirectPurchaseRequest" + } + }, + { + "name": "x-amzn-IdempotencyKey", + "description": "A unique value which the server uses to recognize subsequent retries of the same request.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "locale", + "description": "The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA).\nThe secondary language subtag is almost always a regional designation.\nThis does not support additional subtags beyond the primary and secondary language subtags.\n", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DirectPurchaseResponse" + }, + "examples": { + "application/json": { + "shipmentId": "445454-3232-3232", + "packageDocumentDetailList": [ + { + "packageClientReferenceId": "ASUSDI-45343854", + "trackingId": "T1234567", + "packageDocuments": [ + { + "type": "LABEL", + "format": "PNG", + "contents": "iVBORw0KGgoAAAANSUhEUgAAAywAAATCCAMAAABouZLTAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAB84AAAfOAGTPyf1AAAfLklEQVR42u3dCXajShZAQb2u2v+WX3+XNTBkMgkQoIhz+ndZlsCWucpEA0TcgCn+5y4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC1zaX3fBeaW7YCVhZAHTMDANY4vpw6cninGGH9LIAqZhIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIB9vkM/s9nnGPuDTq3KFw0/4doLODt5SGWFft4bI358/85Z8OM/jEEnhflwm28s8xw0C0OEku8Nur0CL6rvDUeqCrXiCmjf94aS8qxha71w0f1Qbd2te4kofOgeLJpmBnPrqnct+0s3uc5XFhh8P1dSmz/mJe1X+aWnd8le9fJ3GMLO90OfoTuxh+Worj1ZdZaiQmL3fR+L/1ozz6j/th7v07scixbB9m7aDJZaCBuy7epjM0Tz0orE0ejjLPHku1f+zGwZ2ucb06YC89aFean2Xr+4HlXx6256NcfIIbm5r3Lvm4va8pmtvs9ku+Vd8ZYor3pxXPrbXSSjT9YtobU3yfSGvPR1u0fs+loXbOxzMfFr60h+3uRvXWcfxJ2rEFjhVaisnufrX2qzX+PA0zD8reO1zZ/n0Q8voqcdNe2rpnN0SeetWR/tJ++DrqbcuMpgE2eLTtaxAfYwY9bc5YWE4fkZw1ZeqIkynd1DAzxeb3nEKb9GvMfkH92xuP3OajmBRG3zP2TXWXmdvod/On7DtVrRm3f9+r7J9O3m/FWMor7eJHd3cYVB+gs78L2Z9F7+nvav/l9cpUxfM1ccbs6VyprbVKjNeXWf/6j7FAePJZ485o54Sn4uGAo03+tCSlk1NvYdKc6F75+stVZYU78ruMo/CEXT+SuI+J3n2va7sOkjT2nb6Dr7+HH3MHr/vtvsP90uFiysA8/eu3lL+DGNU9jOnsLW6uWDeYVnd9l0pxsm1z+95keKr9GzLrjY9lYOzrcZOa31JKxQi1xxLttixnF/z7xSwy+BPjfff74E76eHp48QOTguJH9Vqav44K15L97O++beXlrj8KA3/ni9U6to92J6/48f2LLHzIKL1ZFv/t4Xiua343nFDj6Edyv0B53e2uM5/caT222X0R73fKEO/2x7Psx4/pR/Fb70ojBRcfC3yiKk46Yc4NY53789XfjP2IMzkQL14ry7WPyPRu1lUXt54odRvAzj1FZuCDb7+irvUa83kqnXOkL3u7CAQamoY9+R3Yq+FdLdX5wXWK5liy+p/rNx9xuLb3PYsXmtUT1B8voxL7dS5iO7nLZalacl7R38ncZQSqfvZlZQoiFvTeVmFxJrP7DD84Q62veIOk/9mavlkMUtrDobEIxY6rT/F71A74xtFVPfPdz58qNjwvXm3hdqfB6wPT3E0y7ok+0X2oH5dZ/b1hWRoYYuE372q1Xq6K0nOr70Sa/Syurg0rnk7IxYcI5871hKZZvjWWX3aGYuFGu/ZbGTX7jybHYZ2HJUwcb7D4f398v+ePG+GXj3+L22bcFffiDLX8/cF/v/AuXjtQ6cPRWB3Z962HoykzDmPvYc7u/Y3L/Vj68h32YaVhudXQFNhmpv3G2+nf/u/qNibAJ0nEGly9kGgYfHVnah2VtHFC1fNjWzjFeO0dg7V3t8ejWW1gUDgdbGJkq77Wdfc4lxLLutDZ/9sryVjq88fO9rJ1jvJaOwPo8MGs0N/rszaG7h4PttlI9mOu1juLKyfZZ2sdKzd6hIZqHba3cPCcfXrWx+KHlVg/m6iiufHKfJXpzn+J74IZuHpN37hvXnnwci+LhMeTCp3bw353VrPoaZlQ/5Oxcfnx0GrbqswXbL8uQwvljWfM9qwMH1TOy8OFp2MGGKEVw3Vh2OrxqmIbx8Vg2ezTPlY5/aLjhALHkjE1xcFfidXjVaLyBb/4LiEMHc73qUVxZ0YYHrIj2qYULB7eJxkFUm/vY7SOwNo+VEKWr9xYfrQV0V1I4mGtzNZucHXHD6aOfcrefcKtPCJjd7PKMRRz+JzxBLD6DD2fbwYfL2PAt+t7Bi1iust8JpmEgFhALiAXEAmIBxAJiAbGAWOB0nIAVvEUfTMPgM+OPaRgYWUAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBxAJiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALHA0WJJdyrX9HfrFfy2E+5pTi9i/Tii9WX0LwTTsFKN7mPEUp11ZakYuzKIZXgkMbAglsrAEkYRxAJi2YFnwxBLfxZW2pvXClew+YuSv+FohfNb9UXJjMpIYmjBNGxqkp4hw8jSm3C98jC2YJ9laAB5pJHSwDQMxLLW7r19FMTy7n4MiKU7sPSHFvv3iGXa0KIVLmCtp47br9Pnc3xp/hPEAqZhgFhALCAWEAuIBcQCYgHEAmIBsYBY4Iy2O27Y8/MsUbw8Zi2jyVs/uUIszRDi31evLfvx4bC49Y9mUT+8Re9IZKt99NIhNfhgLPn4BEvec/GZYuyzDLVSmSblwJiQG31UPwe/94mUPXyIpT1nipGtY6cJUB5uy0ytiKWWRbx161vxc5wrfrTTpsvnRpaFG+cndrXt3vPRHfyhEWXvR/F8/Te2Xku0/53l+2Cfn4izxVJ6CH89NdZ9UP85D+WCgyN3t8ns7jcNHX+pss7edl654LWWbDxCZPfCVhnhiFBiGZrbbPfk8eNp6uy8EvO6YMkyW898Fy+4b/TPS5q/4fPfkY2uUiD2WUpzrxx6JB+ai809OHLjaersXjDjB26u85FZVC/4t5K4P8mQU37EcKQpscyvZfVd7fbT1DMnOOV19p757lyQ3TnVyDAVSx4G+IpYHtOgkRFjjeehsrAbscq++npPSRhTxDL+aF965S3rG+C9ndUegKdspOV1RncRYcNns1juW1Xl5cmNX0187+XxCQNLdmZoZlffZu2njv89b7pkpjXz2ePs3XrB807hdH58MJbf7fa1Cfa2x87WuXRjLT9JPS0XgXCQWDq1NPcRSg/kudJWHLfpuaRyOEYsc16KzBWf1XrkEjuuEzv468rbTltn9fkFOEMs3efB6jsw059gql9zwpO85XX2FtlfR+sSb/MSyzvjR04KZ6PBy3DCWUeWWHijXPuak5c0YWgZmWYKViwblrP8mah4bZuZnZ2hGFxtdZ3NRdYv6M3CGiedjU0eQjiMP7F+FdnZSYnivytbT0zb0gq7QVHYlSgcd6m6zuobKFsXPN4uGr3lRfOnaK0nhn8iTmK9tz09t6DuQ2zrqdru07a9D29VP2PY+052Cq1cJXq3qa+z9znG8gW1hQ48IxC1n4hvjMUp7xELsNcOPogFxAKIBcQCYgGxgFhALCAWQCwgFtjXuqec+PnP5Hdmbv6xDp8b4bCxPE5nEiMf+xjtrckGz1Gsez7TeD2gNz6zmFF6qC8fHyWj/c03RgcHYOGo+yyf2zY/d6AIh6gQy9pbVBamVLnWtlY7qEpuvjE7nItY3p7ZPf6bg4/DMXDjVXZZzMFY1xZHd+l/3Ttcyv0kk0Mb9MChJxrnEK4e5qKwgtLRKspftg9B0fzH6+dIUX6bzU/t/TsdireXEf/NeponkLwfkT8m7yvl40hgMf5l/zTdcf89niuesWZMw/ojQQ4OERlvtfLccB9fLRr4ovxlPr8c2g/JCddBLBNryQnxLNnsorTXc5uzXefQ/pO9IHbewS+e2/t332Hd8z3+ri1mLiMaN6t+adhgl1j+bXmTnk999xTFufUKYONY2oNLrHg+uvzRXIcG2N3qZyvO0r5Ddt/pkgsibK9j8KD1aUDh+LFMO1124xWTRacBH30++s0VwPbTsPrOxboP9RE3uyNcKJbXCxntVziydeKTXL7wkd17u/gcNJbcMrrWMwX5/jJqX3pRnn1HlpHNbeEpimdku+IKDEtsF0v5rcXxbn2tE0fmbf7riM+XgLL25a1zqsjRN7WZ4n2ZVU+TF915zGtby+Z54rrvH+62VLg0m5cMvn24voK8Fb5Vud3z/cX3i/tvrCzdBrHMGlRsO4gF7LMAYgGxgFhALCAWEAsgFhALiAXEAifhzF/wgVic+YtLc+Yv2H2fxZm/EMv7W5QzfyGW8szu8V9n/uJSnPmr9KUzf1HgzF/O/MXu0zBn/kIsc2px5i/EMnVbcuYvxDKpFmf+QixLBhdn/uJanPkLPhSLM39hGvbuvrkzfyGW4Yd3Z/5CLAODyAbROfMX1xxZnPkLsczfupz5i+tw5q/y7Zz5iw1jceYvxAJstYMPYgGxAGIBsYBYQCwgFhALIBYQC4gFPmu1A1a0Ptnh3Zlc0AZn/mof8R5Mw4YD3OwjhD6byLX2WTarxZEoudwOvo+nYwd/8cyp8/H59n7N+KfoXx+iz/bCWh+GdyQjTraD39vdbx3I4udf2bukcWbw9lbf/jLbFcXrkMd5PwayWDjZNKwXTWte1jvTUPuIldE76l1UFxytxSqFM8dS2aPpztLeWIwzoXKNfZbXsfBqx7NvHi2vuslHeUdowvXg1CPLgucH4PIjy7t1/Oy0185bpCK+PJbs7PvXT/NlzsVVpmGxzg0jjCJcOpZc8YZO84Ud/O0HKTh8LP2zp1TfiTL8NrLqOye9+4xrxOI9Wohl0g5HNlvpnVOrOEa8TsIVrfN73eqn+eqeDgy23huIVTsp7mP03nVcPoNW732Vjbcax8DC4lY7gxgcMhYwDQPEAmIBsYBYQCwgFhALIBYQC4gFxAJn8/cUP2XrXcnwGRu/RX/4+N9RXVZ0Fh231kdi2h9hERHniqV25q/O4cKbn18pbeWF7xSOCp5xKy8fzrXP0j3zVxauUYu0/51sHtg1q4XCOXfwVzyaROEjylrhQrEUPyu/7uLhIrFsNMyYhHHBWDqnKsp1cnCwMK49smy3jRtYuFwsJmGI5QC7LXCxkWWLWgwsXHMaZmxBLPZYEMsag8mGQ4tWuEosudJErH0rhfAd07BVxxbZcJVYittybLYuOG0sKz7uN8ej7JzDBc4bS+HMX28PLa1TgWmFz9nhY8X1T0oWAsryQnysmAvFsilnwUMsM5NRC2LZ/XkDuHYsDiCGWIwuiAWuw7GOQSwgFhALiAXEAt/jwCcz6r4J8/gLxsjyIZu9BOS1JT47srTeGDzw2P3GK/CNVTTe9uIlfc4WSzS32miem+u2wSq2WQEcdRr2zofntcL1d/BjjVSaragGO/jGFb5oZHns52d/zz8fX70OQVE9B/hQK+0FRnlBOfTMQ/Oi3kLS0MVrErPBqb0b2/PPZRnFA7Nk95AU2TweRdQ27OiOK60Fttf1u8j2gS6il0fvx3supLM0TMP2mDINH43yd4OMziGPah1nTF3Xb37R7Sr6lzR/vOdCJvzkiGWTPfoJV8qp8U1aV94WPZkQnjrgsDv4s85tn2udzLV1ifGDc8Qyd6CyWfMRB3kj5YztP9Izx3xzLHO2frVgGrb2TMyr/Hx9LDNqyZujvvLVscypJbXChWLpbPpTSphWS2b8qN/oeYnX6dk1ltY5utbY9PLNWnLJguF4I0tjc28+wL++HA5u6tjy61ZZ8OMSAwsTNtk1N5J8vle3dYKvKPzj+e3WG12aZ/bqv5WyeePHvwdX0T+NWGHB/Z+i+gMjlnVzOc6mleX3/8MyK78oeaRN8jWuhJ0UTr3PAmI55nTTn5qD7bMcSjqyGGKZudsiFcQC9llALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFgAAgJVEuA/ADj6IBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmKBzf11F7CpvP9/dC6Y+/X0GxhZuFg83a9z5HqzFyAWsM8CYgGxgFgAsYBYOIuofB0j15u9gA1+dGcrZlO5dl1ZiyO3rsbIAmIBsYBYQCwgFhALbCsq/7/agjf4kb3Owqa6r37k2Eaeu238RhYQC4gFxAJiAbEAYuGYTvTahYPs8Vk5tx6fZwHTMBALiAUQC4gFxMLVeZ0FJkbSe51l7PMs1Rtunp2RBcQCYgGxgFhALCAWoMNxw9jW2PlZJn8spfb6y36vtxhZQCwgFhALiAXEAmIBOnyehX2Mnp+lKyd+P7K9AiMLjESTYgH7LGCf5UNjcYzNeCvvNYr6yD727qT2NbK6qrGfZeAgvcsW+sYK21fyzsGrxZJv3Sbrm2FO31qy+9WSG3ZvtnihS1f47r0qlsuF8rhZPP6R/QEiSt8aE42faOINs3O7/s0WLPS9FWrlkvssme+2cn9gze634vGfORtNtKY2uex2udJCF69QK5cdWWLJnzUb20rkyEYy+dH8cb3IJZvu83bt9S1d6OIVbtbK6H7SY0cxpi4gR74WS++vXt+Mxu71QhHtb0V/JjbjL7H0duss9N0VxqfGlly2m7hgAd81Dds0wv1vPjgviu1+z8Jo6mmwK07DNq5m8k5+HDDaN2ZMWhHL0pH9sIPYJivUyvdNw2JGGLHxtr37wPPGCj0RZp9l943ivDMzA4tYuttCPv8Tq2aVW2yquVcbJmH2Wfr77a/t4iBjQG6x0Lkr3KyVqS+PRO2nG13A5pH/uczDSMz4RgxfYcEFvU0wlm7ssepC566w00qs//fJytej6xxdwOab8heMLKV3C0b53bwx/H6p4WWOb9WL3wy5fKEzV2jn/itjab3pqz+3aNQykEbOWWb93fQjP8tQEcsWunSFaef+i3fwI8qvUrfegZmjpzWctMzBJY7fLsemErMXumSFWvneWG7l93RkZ38wi/PizDnL/Nk2n5tn5bYxtGNd3Ed9b6EzV+iJsG+PpbDB3D8DGDFQy7+3/8esWtrPyczesIdWt3ihc1aoFbEM7IlE3AaeUln4XOSiz57kyOrW/UBLcYV27sd8wVPH3WfwW3P16N38sQk1N6UYW+a73xvfs958hTn/jl3095n6/4sXsJ1vfSPlq43+J3bj3c1l8jPQ01tZsNB3V7jZeD78dc5dUPUFGNOw1f9ocYgfKa69Qvssl5+/7TSNzw/EiWnY3jWttenG3q3E6G+Zt5vxx8hy7GmhccXI8vndgHj3djO/N+1nGXoAX7rQxSvk60eWLGw2k97rmgsfnnPRIqf9FnMXahwxsqy455HD2+AWH97tvnUg11hq7L3CN/8eOfz/B9zFvHAsGeVtvnPIlpx6u6nfK40BQ7eb9EvMXejiFe73oFV/uXThGOnDX9MnWeUneAobWeuvVHoDYwxsZjEwI2od7zWm3C7H/+jzF/rmCkdnfQd54N9/yz11LDn5Huxsf5Pfl754Dhax/I8cKy90/gpzw43yxLFcdRrWPAZyDH679zheHaqGlhmDH9PKZX/hpQtdvEJuCx8BYYPhf7UTwuy/5XpREsQCYoGP8EZKdto7HtuHGb3C1H0dn2cB0zAQC4gFxAKIBcQCe/E6C/sYPapX7bwrtcvfPrybkQXEAmIBsYBYQCyAWOBdf3wGn4+K1Y+Z6fMsXNSJji8rFhALiAXEAmIBscD3cKxjMLKAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGKBFf1dYyHpfuQ4Njvzo5EF9hxZOP6j4tfYcJpjZAGxgFhALCAWuIBTPRtWeKooZ10hhm/k9SIGt781nqvMnXvJ1maes64QpR84Sr9EfCIeTx2/vzFudh/+OdtfJ3pfxrwrRGmT7IYREXGEX48j3Ydnf1Hy53FkcAgoXyHS9sr37eDn2PadMwPIf2waXC+W8T2LNHwglunbfnTjUQvfGMvsocUci2/cwZ+yx96/QsaEW3ydbI/D2bvjWhfXri6WK1JLb6ramqD++zKqF1cvNw274oOo3ZbRXb8Yurh6uVgOvunPfPbYqDJlDy/GL65eLpaLP5AaWpqbf8bIxdXLxWIi9r2PH+Hh5qtHFrWMTMR6I0Xl4urlYrnk3JzyzGr04urlYrHb8kX3SMaUi6uXi8VE7GvumuLGX7m4erlYTMRMxL5zIuYz+IaW4j0SUy+uXi6W844SaSK2wv2Z3zxIXyKWWHwFtajFNMxuyxv3Sfn4A5WLq5eL5VKzMLst5Y2/eI9VLq5eLpaLDi1qKT18eEbsgrHEW1cwESuNFDHx4urlYjlsK/nWFejPqjp3WuXi6uViueYei47m3jXf+ozY+WOJsT/S6BXU0h8ppn20pXr5Nf09fyrvz8HSDr6hZIKzHeu4vTsZ/VFj7ApRfSfHwGIO9GTFxq1E70eJ6sXVy4+wjWyy4DMdRX+tU07cColldSH5LbG0DmaU5Z+scTdVrv7pWlIs38KE8MCxeNcxiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALHB5f90Fh+JwBkYWEAuIBRALiAW2tMqzYQ6juALPgxlZQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgEAANhFhPvgGNJdsNY2bQcfjCxwDkYWEAuIBcQCYgGxgFgAsYBYYFN/V1nK7/ua4t8/4nFJVK5w6135ef3n1W69hRRv2Lx+58KBKw//DMM//MRV3Hq/1+gNo3c/3Hq/flQW2F9j/x4buKOmXGHuzzDl1yzet7fSMvt/sv5KjSxgGgZiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXE4i4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFhALiMVdAGIBsYBYQCwgFhALIBYQC4gFxAJiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCxASYT7AIwsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmf1112wjfz5j4+hiuV7tvafzT1fl8VYDc8b/fe/XLLKGI4tWxdm90cS56Z8Bn9ow71vva//e26bzW+Xb9T/7qS1xtCmn/8WH5WvjGT2WT7XSmfji9cw8/x2NkeU0o26o860AW0gpXits/FVpr+ZWI41Dpc35ilb6uStOce/k/2vwhRBLGecpb653eZgrI2RKzyHsK8/7uzhTbP972hcHJ2xJno3uk+SmtfJ1sWNJwTuF0VnZZXd/+h8dSveorQCjCxbhDLyEJ/37TXiMQ3q3yjvM7DndSJa86iIRmXPL1bc/+ivALFsUksOjzq956u6N8oo7kvk76W5JFPEctBJWM7cvejcKMrX60zm7s9nRXUutc6TEl6FEcu2O/dZzaQcU+FGsXjzRiwX2HHJekxzp1H3NDKGx6y3hxYDi1i2n4qVW6nvjMeGkSKW08jiE8orPPJnjNYSrX/G9J+isALEsmIVudeNirOuGLha5YX8mU9FIJZtZ2LZf4Ir5tyovoqYUEvlpfuY9DsYWMSy6Yyr+3ic3Zfps7UL3b9RtvZvcnGkz8uy8cbk9lfs8MDpvh6auHR2HqI7r+m+P775KZR8vbvldZ1HXtla4H2Hov0ZltJeRvXzLDk8zthjEcuXJDv7yYRlt8I0DIwsYGQBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmIBsQBiAbGAWEAsIBYQC4gFEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgHEAmIBsYBYQCwgFhALIBYQC4gFxAJiAbEAYgGxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIByv4PwWms3AV97VoAAAAASUVORK5CYII=" + } + ] + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + }, + "x-amzn-IdempotencyKey": { + "type": "string", + "description": "A unique value which the server uses to recognize subsequent retries of the same request." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "ChannelDetails object cannot be null" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + }, + "parameters": [] + }, + "/shipping/v2/shipments": { + "post": { + "tags": [ + "shipping" + ], + "description": "Purchases a shipping service and returns purchase related details and documents.\n\nNote: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "purchaseShipment", + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PurchaseShipmentRequest" + } + }, + { + "name": "x-amzn-IdempotencyKey", + "description": "A unique value which the server uses to recognize subsequent retries of the same request.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/PurchaseShipmentResponse" + }, + "examples": { + "application/json": { + "shipmentId": "87852211788104", + "packageDocumentDetails": [ + { + "packageClientReferenceId": "abcd", + "packageDocuments": [ + { + "type": "LABEL", + "format": "PNG", + "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac==" + } + ], + "trackingId": 1578648261977 + } + ], + "promise": { + "pickupWindow": { + "start": "2019-12-11T07:09:05.513Z", + "end": "2019-12-11T09:09:05.513Z" + }, + "deliveryWindow": { + "start": "2019-12-13T07:09:05.513Z", + "end": "2019-12-13T09:09:05.513Z" + } + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "RateId cannot be null" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + }, + "x-amzn-api-sandbox": { + "dynamic": {} + } + }, + "parameters": [] + }, + "/shipping/v2/tracking": { + "get": { + "tags": [ + "shipping" + ], + "description": "Returns tracking information for a purchased shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getTracking", + "parameters": [ + { + "name": "trackingId", + "in": "query", + "description": "A carrier-generated tracking identifier originally returned by the purchaseShipment operation.", + "required": true, + "type": "string" + }, + { + "name": "carrierId", + "in": "query", + "description": "A carrier identifier originally returned by the getRates operation for the selected rate.", + "required": true, + "type": "string" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetTrackingResponse" + }, + "examples": { + "application/json": { + "trackingId": "23AA47DE2B3B6", + "alternateLegTrackingId": "null", + "eventHistory": [ + { + "eventCode": "ReadyForReceive", + "location": { + "postalCode": "4883493", + "countryCode": "CC" + }, + "eventTime": "2019-12-11T07:09:05.513Z" + } + ], + "promisedDeliveryDate": "2019-12-12T13:09:05.513Z", + "summary": { + "status": "PreTransit" + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "CarrierId is missing in the request" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + }, + "x-amzn-api-sandbox": { + "dynamic": {} + } + }, + "parameters": [] + }, + "/shipping/v2/shipments/{shipmentId}/documents": { + "get": { + "tags": [ + "shipping" + ], + "description": "Returns the shipping documents associated with a package in a shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getShipmentDocuments", + "parameters": [ + { + "name": "shipmentId", + "description":"The shipment identifier originally returned by the purchaseShipment operation.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "packageClientReferenceId", + "in": "query", + "description": "The package client reference identifier originally provided in the request body parameter for the getRates operation.", + "required": true, + "type": "string" + }, + { + "name": "format", + "in": "query", + "description": "The file format of the document. Must be one of the supported formats returned by the getRates operation.", + "required": false, + "type": "string" + }, + { + "name": "dpi", + "in": "query", + "description": "The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.", + "required": false, + "type": "number" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetShipmentDocumentsResponse" + }, + "examples": { + "application/json": { + "shipmentId": "445454-3232-3232", + "packageDocumentDetail": { + "packageClientReferenceId": "ASUSDI-45343854", + "trackingId": "T1234567", + "packageDocuments": [ + { + "type": "LABEL", + "format": "PNG", + "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac==" + } + ] + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "shipmentId is missing in the request" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + }, + "x-amzn-api-sandbox": { + "dynamic": {} + } + }, + "parameters": [] + }, + "/shipping/v2/shipments/{shipmentId}/cancel": { + "put": { + "tags": [ + "shipping" + ], + "description": "Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "cancelShipment", + "parameters": [ + { + "name": "shipmentId", + "description":"The shipment identifier originally returned by the purchaseShipment operation.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/CancelShipmentResponse" + }, + "examples": { + "application/json": {} + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "ShipmentId cannot be null" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + }, + "x-amzn-api-sandbox": { + "dynamic": {} + } + }, + "parameters": [] + }, + "/shipping/v2/shipments/additionalInputs/schema": { + "get": { + "tags": [ + "shipping" + ], + "description": "Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 80 | 100 |\n\nThe `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](doc:usage-plans-and-rate-limits-in-the-sp-api).", + "operationId": "getAdditionalInputs", + "parameters": [ + { + "name": "requestToken", + "in": "query", + "description": "The request token returned in the response to the getRates operation.", + "required": true, + "type": "string" + }, + { + "name": "rateId", + "in": "query", + "description": "The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.", + "required": true, + "type": "string" + }, + { + "name": "x-amzn-shipping-business-id", + "in": "header", + "description": "Amazon shipping business to assume for this request. The default is AmazonShipping_UK.", + "required": false, + "type": "string", + "enum": [ + "AmazonShipping_US", + "AmazonShipping_IN", + "AmazonShipping_UK", + "AmazonShipping_UAE", + "AmazonShipping_SA", + "AmazonShipping_EG", + "AmazonShipping_IT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AmazonShipping_US", + "description": "The United States Amazon shipping business." + }, + { + "value": "AmazonShipping_IN", + "description": "The India Amazon shipping business." + }, + { + "value": "AmazonShipping_UK", + "description": "The United Kingdom Amazon shipping business." + }, + { + "value": "AmazonShipping_UAE", + "description": "The United Arab Emirates Amazon shipping business." + }, + { + "value": "AmazonShipping_SA", + "description": "The Saudi Arabia Amazon shipping business." + }, + { + "value": "AmazonShipping_EG", + "description": "The Egypt Amazon shipping business." + }, + { + "value": "AmazonShipping_IT", + "description": "The Italy Amazon shipping business." + } + ] + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/GetAdditionalInputsResponse" + }, + "examples": { + "application/json": { + "payload": { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Additional inputs for Shipping Offering", + "type": "object", + "properties": { + "harmonizedSystemCode": { + "type": "string", + "description": "Harmonized System's commodity code for an item." + }, + "packageClientReferenceId": { + "type": "string", + "description": "Unique identifier for the item." + } + } + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "requestToken": { + "value": "amzn1.rq.123456789.101" + }, + "rateId": { + "value": "122324234543535321345436534321423423523452345" + } + } + }, + "response": { + "payload": { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Additional inputs for Shipping Offering", + "type": "object", + "properties": { + "harmonizedSystemCode": { + "type": "string", + "description": "Harmonized System's commodity code for an item." + }, + "packageClientReferenceId": { + "type": "string", + "description": "Unqiue identifier for the item." + } + } + } + } + } + ] + } + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "RequestToken cannot be null" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amzn-api-sandbox": { + "static": [ + { + "request": { + "parameters": { + "requestToken": { + "value": "null" + }, + "rateId": { + "value": "2314346237423894905834905890346890789075" + } + } + }, + "response": { + "errors": [ + { + "code": "InvalidRequest", + "message": "Request is missing or has invalid parameters", + "details": "RequestToken cannot be null" + } + ] + } + } + ] + } + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "Unauthorized", + "message": "You don't have access to the requested response or the credentials are invalid." + } + ] + } + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "NotFound", + "message": "The requested resource is invalid or doesn't exist" + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload size is greater than maximum accepted size." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InvalidRequest", + "message": "The request payload format is not supported." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "TooManyRequests", + "message": "The total number of requests exceeded your allowed limit." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "InternalError", + "message": "Something went wrong while processing the request." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "examples": { + "application/json": { + "errors": [ + { + "code": "ServiceUnavailable", + "message": "Service temporarily unavailable or down for maintenance. Please try again after sometime." + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + }, + "parameters": [] + } + }, + "definitions": { + "Error": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "Error response returned when the request is unsuccessful." + }, + "ErrorList": { + "type": "array", + "description": "A list of error responses returned when a request is unsuccessful.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "Weight": { + "description": "The weight in the units indicated.", + "type": "object", + "required": [ + "unit", + "value" + ], + "properties": { + "unit": { + "type": "string", + "description": "The unit of measurement.", + "enum": [ + "GRAM", + "KILOGRAM", + "OUNCE", + "POUND" + ], + "x-docgen-enum-table-extension": [ + { + "value": "GRAM", + "description": "Metric unit of mass equal to one thousandth of a kilogram." + }, + { + "value": "KILOGRAM", + "description": "Metric unit of mass." + }, + { + "value": "OUNCE", + "description": "The imperial unit of weight that is one sixteenth of a pound." + }, + { + "value": "POUND", + "description": "The imperial unit of weight." + } + ] + }, + "value": { + "type": "number", + "description": "The measurement value." + } + } + }, + "InvoiceDetails": { + "description": "The invoice details for charges associated with the goods in the package. Only applies to certain regions.", + "type": "object", + "properties": { + "invoiceNumber": { + "type": "string", + "description": "The invoice number of the item." + }, + "invoiceDate": { + "type": "string", + "format": "date-time", + "description": "The invoice date of the item in ISO 8061 format." + } + } + }, + "ChargeList": { + "type": "array", + "description": "A list of charges based on the shipping service charges applied on a package.", + "items": { + "$ref": "#/definitions/ChargeComponent" + } + }, + "ChargeComponent": { + "type": "object", + "description": "The type and amount of a charge applied on a package.", + "properties": { + "amount": { + "$ref": "#/definitions/Currency" + }, + "chargeType": { + "type": "string", + "description": "The type of charge.", + "enum": [ + "TAX", + "DISCOUNT" + ], + "x-docgen-enum-table-extension": [ + { + "value": "TAX", + "description": "A tax imposed on a package." + }, + { + "value": "DISCOUNT", + "description": "A discount deducted from the cost of a package." + } + ] + } + } + }, + "Currency": { + "description": "The monetary value in the currency indicated, in ISO 4217 standard format.", + "type": "object", + "required": [ + "unit", + "value" + ], + "properties": { + "value": { + "type": "number", + "description": "The monetary value." + }, + "unit": { + "type": "string", + "description": "The ISO 4217 format 3-character currency code.", + "minLength": 3, + "maxLength": 3 + } + } + }, + "Dimensions": { + "type": "object", + "required": [ + "height", + "length", + "unit", + "width" + ], + "properties": { + "length": { + "type": "number", + "description": "The length of the package." + }, + "width": { + "type": "number", + "description": "The width of the package." + }, + "height": { + "type": "number", + "description": "The height of the package." + }, + "unit": { + "type": "string", + "description": "The unit of measurement.", + "enum": [ + "INCH", + "CENTIMETER" + ], + "x-docgen-enum-table-extension": [ + { + "value": "INCH", + "description": "The imperial unit of length equal to one twelfth of a foot." + }, + { + "value": "CENTIMETER", + "description": "A metric unit of length, equal to one hundredth of a meter." + } + ] + } + }, + "description": "A set of measurements for a three-dimensional object." + }, + "RequestToken": { + "type": "string", + "description": "A unique token generated to identify a getRates operation." + }, + "RateId": { + "type": "string", + "description": "An identifier for the rate (shipment offering) provided by a shipping service provider." + }, + "CarrierId": { + "type": "string", + "description": "The carrier identifier for the offering, provided by the carrier." + }, + "CarrierName": { + "type": "string", + "description": "The carrier name for the offering." + }, + "PackageClientReferenceId": { + "type": "string", + "description": "A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation." + }, + "ShipmentId": { + "type": "string", + "description": "The unique shipment identifier provided by a shipping service." + }, + "TrackingId": { + "type": "string", + "description": "The carrier generated identifier for a package in a purchased shipment." + }, + "AlternateLegTrackingId": { + "type": "string", + "description": "The carrier generated reverse identifier for a returned package in a purchased shipment." + }, + "ServiceId": { + "type": "string", + "description": "An identifier for the shipping service." + }, + "ServiceName": { + "type": "string", + "description": "The name of the shipping service." + }, + "Address": { + "type": "object", + "required": [ + "addressLine1", + "city", + "countryCode", + "name", + "postalCode", + "stateOrRegion" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the person, business or institution at the address.", + "minLength": 1, + "maxLength": 50 + }, + "addressLine1": { + "type": "string", + "description": "The first line of the address.", + "minLength": 1, + "maxLength": 60 + }, + "addressLine2": { + "type": "string", + "description": "Additional address information, if required.", + "minLength": 1, + "maxLength": 60 + }, + "addressLine3": { + "type": "string", + "description": "Additional address information, if required.", + "minLength": 1, + "maxLength": 60 + }, + "companyName": { + "type": "string", + "description": "The name of the business or institution associated with the address." + }, + "stateOrRegion": { + "$ref": "#/definitions/StateOrRegion" + }, + "city": { + "$ref": "#/definitions/City" + }, + "countryCode": { + "$ref": "#/definitions/CountryCode" + }, + "postalCode": { + "$ref": "#/definitions/PostalCode" + }, + "email": { + "type": "string", + "description": "The email address of the contact associated with the address.", + "maxLength": 64 + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the person, business or institution located at that address, including the country calling code.", + "minLength": 1, + "maxLength": 20 + } + }, + "description": "The address." + }, + "StateOrRegion": { + "type": "string", + "description": "The state, county or region where the person, business or institution is located." + }, + "City": { + "type": "string", + "description": "The city or town where the person, business or institution is located." + }, + "CountryCode": { + "type": "string", + "description": "The two digit country code. Follows ISO 3166-1 alpha-2 format." + }, + "PostalCode": { + "type": "string", + "description": "The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation." + }, + "Location": { + "type": "object", + "properties": { + "stateOrRegion": { + "$ref": "#/definitions/StateOrRegion" + }, + "city": { + "$ref": "#/definitions/City" + }, + "countryCode": { + "$ref": "#/definitions/CountryCode" + }, + "postalCode": { + "$ref": "#/definitions/PostalCode" + } + }, + "description": "The location where the person, business or institution is located." + }, + "DocumentFormat": { + "type": "string", + "description": "The file format of the document.", + "enum": [ + "PDF", + "PNG", + "ZPL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "PDF", + "description": "The Portable Document Format (PDF) file format. Used to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems." + }, + { + "value": "PNG", + "description": "Portable Network Graphics (PNG) is a raster-graphics file format that supports lossless data compression." + }, + { + "value": "ZPL", + "description": "Zebra Programming Language (ZPL) format is from Zebra Technologies. It's used primarily for labeling applications and can only be used with ZPL compatible printers." + } + ] + }, + "DocumentType": { + "type": "string", + "description": "The type of shipping document.", + "enum": [ + "PACKSLIP", + "LABEL", + "RECEIPT", + "CUSTOM_FORM" + ], + "x-docgen-enum-table-extension": [ + { + "value": "PACKSLIP", + "description": "A listing of the items packed within the shipment." + }, + { + "value": "LABEL", + "description": "The shipping label for the specific shipment." + }, + { + "value": "RECEIPT", + "description": "The receipt of the shipment." + }, + { + "value": "CUSTOM_FORM", + "description": "The customs documentation for a cross-border shipment." + } + ] + }, + "Dpi": { + "type": "integer", + "description": "The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document." + }, + "PageLayout": { + "type": "string", + "description": "Indicates the position of the label on the paper. Should be the same value as returned in getRates response." + }, + "NeedFileJoining": { + "type": "boolean", + "description": "When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false." + }, + "Contents": { + "type": "string", + "description": "A Base64 encoded string of the file contents." + }, + "PackageDocumentList": { + "type": "array", + "description": "A list of documents related to a package.", + "items": { + "$ref": "#/definitions/PackageDocument" + } + }, + "PackageDocument": { + "type": "object", + "required": [ + "contents", + "format", + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/DocumentType" + }, + "format": { + "$ref": "#/definitions/DocumentFormat" + }, + "contents": { + "$ref": "#/definitions/Contents" + } + }, + "description": "A document related to a package." + }, + "PrintOptionList": { + "type": "array", + "description": "A list of the format options for a label.", + "items": { + "$ref": "#/definitions/PrintOption" + } + }, + "PrintOption": { + "type": "object", + "required": [ + "supportedDocumentDetails", + "supportedFileJoiningOptions", + "supportedPageLayouts" + ], + "properties": { + "supportedDPIs": { + "type": "array", + "description": "A list of the supported DPI options for a document.", + "items": { + "$ref": "#/definitions/Dpi" + } + }, + "supportedPageLayouts": { + "type": "array", + "description": "A list of the supported page layout options for a document.", + "items": { + "$ref": "#/definitions/PageLayout" + } + }, + "supportedFileJoiningOptions": { + "type": "array", + "description": "A list of the supported needFileJoining boolean values for a document.", + "items": { + "$ref": "#/definitions/NeedFileJoining" + } + }, + "supportedDocumentDetails": { + "description": "A list of the supported documented details.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedDocumentDetail" + } + } + }, + "description": "The format options available for a label." + }, + "DocumentSize": { + "type": "object", + "required": [ + "length", + "unit", + "width" + ], + "properties": { + "width": { + "description": "The width of the document measured in the units specified.", + "type": "number" + }, + "length": { + "description": "The length of the document measured in the units specified.", + "type": "number" + }, + "unit": { + "type": "string", + "description": "The unit of measurement.", + "enum": [ + "INCH", + "CENTIMETER" + ], + "x-docgen-enum-table-extension": [ + { + "value": "INCH", + "description": "The imperial unit of length equal to one twelfth of a foot." + }, + { + "value": "CENTIMETER", + "description": "A metric unit of length, equal to one hundredth of a meter." + } + ] + } + }, + "description": "The size dimensions of the label." + }, + "SupportedDocumentDetail": { + "type": "object", + "required": [ + "isMandatory", + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/DocumentType" + }, + "isMandatory": { + "type": "boolean", + "description": "When true, the supported document type is required." + } + }, + "description": "The supported document types for a service offering." + }, + "RequestedDocumentSpecification": { + "type": "object", + "required": [ + "format", + "needFileJoining", + "requestedDocumentTypes", + "size" + ], + "properties": { + "format": { + "$ref": "#/definitions/DocumentFormat" + }, + "size": { + "$ref": "#/definitions/DocumentSize" + }, + "dpi": { + "$ref": "#/definitions/Dpi" + }, + "pageLayout": { + "$ref": "#/definitions/PageLayout" + }, + "needFileJoining": { + "$ref": "#/definitions/NeedFileJoining" + }, + "requestedDocumentTypes": { + "description": "A list of the document types requested.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentType" + } + } + }, + "description": "The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation." + }, + "SupportedDocumentSpecificationList": { + "type": "array", + "description": "A list of the document specifications supported for a shipment service offering.", + "items": { + "$ref": "#/definitions/SupportedDocumentSpecification" + } + }, + "SupportedDocumentSpecification": { + "type": "object", + "required": [ + "format", + "printOptions", + "size" + ], + "properties": { + "format": { + "$ref": "#/definitions/DocumentFormat" + }, + "size": { + "$ref": "#/definitions/DocumentSize" + }, + "printOptions": { + "$ref": "#/definitions/PrintOptionList" + } + }, + "description": "Document specification that is supported for a service offering." + }, + "Item": { + "type": "object", + "required": [ + "quantity" + ], + "properties": { + "itemValue": { + "$ref": "#/definitions/Currency" + }, + "description": { + "type": "string", + "description": "The product description of the item." + }, + "itemIdentifier": { + "type": "string", + "description": "A unique identifier for an item provided by the client." + }, + "quantity": { + "type": "integer", + "description": "The number of units. This value is required." + }, + "weight": { + "$ref": "#/definitions/Weight" + }, + "isHazmat": { + "type": "boolean", + "description": "When true, the item qualifies as hazardous materials (hazmat). Defaults to false." + }, + "productType": { + "type": "string", + "description": "The product type of the item." + }, + "invoiceDetails": { + "$ref": "#/definitions/InvoiceDetails" + }, + "serialNumbers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon." + }, + "directFulfillmentItemIdentifiers": { + "$ref": "#/definitions/DirectFulfillmentItemIdentifiers" + } + }, + "description": "An item in a package." + }, + "ItemList": { + "type": "array", + "description": "A list of items.", + "items": { + "$ref": "#/definitions/Item" + } + }, + "Package": { + "type": "object", + "required": [ + "dimensions", + "insuredValue", + "items", + "packageClientReferenceId", + "weight" + ], + "properties": { + "dimensions": { + "$ref": "#/definitions/Dimensions" + }, + "weight": { + "$ref": "#/definitions/Weight" + }, + "insuredValue": { + "$ref": "#/definitions/Currency" + }, + "isHazmat": { + "type": "boolean", + "description": "When true, the package contains hazardous materials. Defaults to false." + }, + "sellerDisplayName": { + "type": "string", + "description": "The seller name displayed on the label." + }, + "charges": { + "$ref": "#/definitions/ChargeList" + }, + "packageClientReferenceId": { + "$ref": "#/definitions/PackageClientReferenceId" + }, + "items": { + "$ref": "#/definitions/ItemList" + } + }, + "description": "A package to be shipped through a shipping service offering." + }, + "PackageList": { + "type": "array", + "description": "A list of packages to be shipped through a shipping service offering.", + "items": { + "$ref": "#/definitions/Package" + } + }, + "DirectFulfillmentItemIdentifiers": { + "type": "object", + "required": [ + "lineItemID" + ], + "properties": { + "lineItemID": { + "type": "string", + "description": "A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped." + }, + "pieceNumber": { + "type": "string", + "description": "A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1." + } + }, + "description": "Item identifiers for an item in a direct fulfillment shipment." + }, + "PackageDocumentDetail": { + "type": "object", + "required": [ + "packageClientReferenceId", + "packageDocuments" + ], + "properties": { + "packageClientReferenceId": { + "$ref": "#/definitions/PackageClientReferenceId" + }, + "packageDocuments": { + "$ref": "#/definitions/PackageDocumentList" + }, + "trackingId": { + "$ref": "#/definitions/TrackingId" + } + }, + "description": "The post-purchase details of a package that will be shipped using a shipping service." + }, + "PackageDocumentDetailList": { + "type": "array", + "description": "A list of post-purchase details about a package that will be shipped using a shipping service.", + "items": { + "$ref": "#/definitions/PackageDocumentDetail" + } + }, + "TimeWindow": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start time of the time window." + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end time of the time window." + } + }, + "description": "The start and end time that specifies the time interval of an event." + }, + "Promise": { + "type": "object", + "properties": { + "deliveryWindow": { + "$ref": "#/definitions/TimeWindow" + }, + "pickupWindow": { + "$ref": "#/definitions/TimeWindow" + } + }, + "description": "The time windows promised for pickup and delivery events." + }, + "RequestedValueAddedServiceList": { + "type": "array", + "description": "The value-added services to be added to a shipping service purchase.", + "items": { + "$ref": "#/definitions/RequestedValueAddedService" + } + }, + "RequestedValueAddedService": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "The identifier of the selected value-added service. Must be among those returned in the response to the getRates operation." + } + }, + "description": "A value-added service to be applied to a shipping service purchase." + }, + "AvailableValueAddedServiceGroupList": { + "type": "array", + "description": "A list of value-added services available for a shipping service offering.", + "items": { + "$ref": "#/definitions/AvailableValueAddedServiceGroup" + } + }, + "AvailableValueAddedServiceGroup": { + "type": "object", + "required": [ + "groupDescription", + "groupId", + "isRequired" + ], + "properties": { + "groupId": { + "type": "string", + "description": "The type of the value-added service group." + }, + "groupDescription": { + "type": "string", + "description": "The name of the value-added service group." + }, + "isRequired": { + "type": "boolean", + "description": "When true, one or more of the value-added services listed must be specified." + }, + "valueAddedServices": { + "type": "array", + "description": "A list of optional value-added services available for purchase with a shipping service offering.", + "items": { + "$ref": "#/definitions/ValueAddedService" + } + } + }, + "description": "The value-added services available for purchase with a shipping service offering." + }, + "ValueAddedService": { + "type": "object", + "required": [ + "cost", + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "The identifier for the value-added service." + }, + "name": { + "type": "string", + "description": "The name of the value-added service." + }, + "cost": { + "description": "The cost of the value-added service.", + "$ref": "#/definitions/Currency" + } + }, + "description": "A value-added service available for purchase with a shipment service offering." + }, + "CollectOnDelivery": { + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "$ref": "#/definitions/Currency" + } + }, + "description": "The amount to collect on delivery." + }, + "ValueAddedServiceDetails": { + "type": "object", + "properties": { + "collectOnDelivery": { + "$ref": "#/definitions/CollectOnDelivery" + } + }, + "description": "A collection of supported value-added services." + }, + "TaxType": { + "type": "string", + "description": "Indicates the type of tax.", + "enum": [ + "GST" + ], + "x-docgen-enum-table-extension": [ + { + "value": "GST", + "description": "Goods and Services Tax." + } + ] + }, + "TaxDetail": { + "description": "Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.", + "type": "object", + "required": [ + "taxRegistrationNumber", + "taxType" + ], + "properties": { + "taxType": { + "$ref": "#/definitions/TaxType" + }, + "taxRegistrationNumber": { + "description": "The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions.", + "type": "string" + } + } + }, + "TaxDetailList": { + "type": "array", + "description": "A list of tax detail information.", + "items": { + "$ref": "#/definitions/TaxDetail" + } + }, + "EventCode": { + "type": "string", + "description": "The tracking event type.", + "enum": [ + "ReadyForReceive", + "PickupDone", + "Delivered", + "Departed", + "DeliveryAttempted", + "Lost", + "OutForDelivery", + "ArrivedAtCarrierFacility", + "Rejected", + "Undeliverable", + "PickupCancelled" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ReadyForReceive", + "description": "Package has been created and is ready for pickup at the shippers location. This is a pre-transit status event code." + }, + { + "value": "PickupDone", + "description": "Package has been picked up by the service provider." + }, + { + "value": "Delivered", + "description": "Package has been delivered." + }, + { + "value": "Departed", + "description": "Package has departed from a particular location in carrier network." + }, + { + "value": "DeliveryAttempted", + "description": "Delivery was attempted, but was unsuccessful." + }, + { + "value": "Lost", + "description": "Package is lost." + }, + { + "value": "OutForDelivery", + "description": "Package is out for delivery." + }, + { + "value": "ArrivedAtCarrierFacility", + "description": "Package is in transit and has been received at a carrier location." + }, + { + "value": "Rejected", + "description": "Package was rejected by the recipient." + }, + { + "value": "Undeliverable", + "description": "Package is undeliverable." + }, + { + "value": "PickupCancelled", + "description": "Pickup scheduled for the package was cancelled." + } + ] + }, + "Event": { + "type": "object", + "required": [ + "eventCode", + "eventTime" + ], + "properties": { + "eventCode": { + "$ref": "#/definitions/EventCode" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO 8601 formatted timestamp of the event." + } + }, + "description": "A tracking event." + }, + "TrackingSummary": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/Status" + } + }, + "description": "A package status summary." + }, + "Status": { + "type": "string", + "description": "The status of the package being shipped.", + "enum": [ + "PreTransit", + "InTransit", + "Delivered", + "Lost", + "OutForDelivery", + "Rejected", + "Undeliverable", + "DeliveryAttempted", + "PickupCancelled" + ], + "x-docgen-enum-table-extension": [ + { + "value": "PreTransit", + "description": "Package has been created but has not been picked up." + }, + { + "value": "InTransit", + "description": "Package has been picked up and is in transit." + }, + { + "value": "Delivered", + "description": "Package has has been delivered successfully." + }, + { + "value": "Lost", + "description": "Package is lost." + }, + { + "value": "OutForDelivery", + "description": "Package is out for delivery." + }, + { + "value": "Rejected", + "description": "Package has been rejected by the recipient." + }, + { + "value": "Undeliverable", + "description": "Package was undeliverable." + }, + { + "value": "DeliveryAttempted", + "description": "Delivery was attempted to the recipient location, but was not delivered." + }, + { + "value": "PickupCancelled", + "description": "Pickup was cancelled for the package." + } + ] + }, + "AmazonOrderDetails": { + "type": "object", + "required": [ + "orderId" + ], + "properties": { + "orderId": { + "type": "string", + "description": "The Amazon order ID associated with the Amazon order fulfilled by this shipment." + } + }, + "description": "Amazon order information. This is required if the shipment source channel is Amazon." + }, + "AmazonShipmentDetails": { + "type": "object", + "required": [ + "shipmentId" + ], + "properties": { + "shipmentId": { + "type": "string", + "description": "This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID." + } + }, + "description": "Amazon shipment information." + }, + "ChannelDetails": { + "type": "object", + "required": [ + "channelType" + ], + "properties": { + "channelType": { + "type": "string", + "description": "The shipment source channel type.", + "enum": [ + "AMAZON", + "EXTERNAL" + ], + "x-docgen-enum-table-extension": [ + { + "value": "AMAZON", + "description": "Indicates that the shipment originates from an Amazon order." + }, + { + "value": "EXTERNAL", + "description": "Indicates that the shipment originates from a non-Amazon channel." + } + ] + }, + "amazonOrderDetails": { + "$ref": "#/definitions/AmazonOrderDetails" + }, + "amazonShipmentDetails": { + "$ref": "#/definitions/AmazonShipmentDetails" + } + }, + "description": "Shipment source channel related information." + }, + "RateList": { + "type": "array", + "description": "A list of eligible shipping service offerings.", + "items": { + "$ref": "#/definitions/Rate" + } + }, + "Rate": { + "type": "object", + "required": [ + "carrierId", + "carrierName", + "promise", + "rateId", + "requiresAdditionalInputs", + "serviceId", + "serviceName", + "supportedDocumentSpecifications", + "totalCharge" + ], + "properties": { + "rateId": { + "$ref": "#/definitions/RateId" + }, + "carrierId": { + "$ref": "#/definitions/CarrierId" + }, + "carrierName": { + "$ref": "#/definitions/CarrierName" + }, + "serviceId": { + "$ref": "#/definitions/ServiceId" + }, + "serviceName": { + "$ref": "#/definitions/ServiceName" + }, + "billedWeight": { + "$ref": "#/definitions/Weight" + }, + "totalCharge": { + "$ref": "#/definitions/Currency" + }, + "promise": { + "$ref": "#/definitions/Promise" + }, + "supportedDocumentSpecifications": { + "$ref": "#/definitions/SupportedDocumentSpecificationList" + }, + "availableValueAddedServiceGroups": { + "$ref": "#/definitions/AvailableValueAddedServiceGroupList" + }, + "requiresAdditionalInputs": { + "type": "boolean", + "description" : "When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation." + } + }, + "description": "The details of a shipping service offering." + }, + "IneligibilityReasonCode": { + "type": "string", + "description": "Reasons that make a shipment service offering ineligible.", + "enum": [ + "NO_COVERAGE", + "PICKUP_SLOT_RESTRICTION", + "UNSUPPORTED_VAS", + "VAS_COMBINATION_RESTRICTION", + "SIZE_RESTRICTIONS", + "WEIGHT_RESTRICTIONS", + "LATE_DELIVERY", + "PROGRAM_CONSTRAINTS", + "TERMS_AND_CONDITIONS_NOT_ACCEPTED", + "UNKNOWN" + ], + "x-docgen-enum-table-extension": [ + { + "value": "NO_COVERAGE", + "description": "The shipment is ineligible because there is no coverage to that address." + }, + { + "value": "PICKUP_SLOT_RESTRICTION", + "description": "The shipment is ineligible because there is an issue with the pickup slot." + }, + { + "value": "UNSUPPORTED_VAS", + "description": "The shipment is ineligible because the value-added service is invalid for this shipment." + }, + { + "value": "VAS_COMBINATION_RESTRICTION", + "description": "The shipment is ineligible because an invalid combination of value-added services were chosen." + }, + { + "value": "SIZE_RESTRICTIONS", + "description": "The shipment is ineligible because the package dimensions are unsupported." + }, + { + "value": "WEIGHT_RESTRICTIONS", + "description": "The shipment is ineligible because the weight is unsupported." + }, + { + "value": "LATE_DELIVERY", + "description": "The shipment is ineligible because delivery is too late." + }, + { + "value": "PROGRAM_CONSTRAINTS", + "description": "The shipment is ineligible because of program constraints." + }, + { + "value": "TERMS_AND_CONDITIONS_NOT_ACCEPTED", + "description": "The shipment is ineligible because terms and conditions have not been accepted by the carrier." + }, + { + "value": "UNKNOWN", + "description": "The ineligibility reason is unknown." + } + ] + }, + "IneligibilityReason" : { + "description": "The reason why a shipping service offering is ineligible.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "$ref": "#/definitions/IneligibilityReasonCode" + }, + "message": { + "type": "string", + "description": "The ineligibility reason." + } + } + }, + "IneligibleRate": { + "description": "Detailed information for an ineligible shipping service offering.", + "type": "object", + "required": [ + "carrierId", + "carrierName", + "ineligibilityReasons", + "serviceId", + "serviceName" + ], + "properties": { + "serviceId": { + "$ref": "#/definitions/ServiceId" + }, + "serviceName": { + "$ref": "#/definitions/ServiceName" + }, + "carrierName": { + "$ref": "#/definitions/CarrierName" + }, + "carrierId": { + "$ref": "#/definitions/CarrierId" + }, + "ineligibilityReasons": { + "type": "array", + "description": "A list of reasons why a shipping service offering is ineligible.", + "items": { + "$ref": "#/definitions/IneligibilityReason" + } + } + } + }, + "IneligibleRateList": { + "type": "array", + "description": "A list of ineligible shipping service offerings.", + "items": { + "$ref": "#/definitions/IneligibleRate" + } + }, + "CancelShipmentResult": { + "type": "object", + "description": "The payload for the cancelShipment operation.", + "additionalProperties": {} + }, + "CancelShipmentResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/CancelShipmentResult" + } + }, + "description": "Response schema for the cancelShipment operation." + }, + "GetRatesRequest": { + "description": "The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.", + "type": "object", + "required": [ + "channelDetails", + "packages", + "shipFrom" + ], + "properties": { + "shipTo": { + "description": "The ship to address.", + "$ref": "#/definitions/Address" + }, + "shipFrom": { + "description": "The ship from address.", + "$ref": "#/definitions/Address" + }, + "returnTo": { + "description": "The return to address.", + "$ref": "#/definitions/Address" + }, + "shipDate": { + "type": "string", + "format": "date-time", + "description": "The ship date and time (the requested pickup). This defaults to the current date and time." + }, + "packages": { + "$ref": "#/definitions/PackageList" + }, + "valueAddedServices": { + "$ref": "#/definitions/ValueAddedServiceDetails" + }, + "taxDetails": { + "$ref": "#/definitions/TaxDetailList" + }, + "channelDetails": { + "$ref": "#/definitions/ChannelDetails" + } + } + }, + "GetRatesResult": { + "type": "object", + "required": [ + "rates", + "requestToken" + ], + "properties": { + "requestToken": { + "$ref": "#/definitions/RequestToken" + }, + "rates": { + "$ref": "#/definitions/RateList" + }, + "ineligibleRates": { + "$ref": "#/definitions/IneligibleRateList" + } + }, + "description": "The payload for the getRates operation." + }, + "GetRatesResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/GetRatesResult" + } + }, + "description": "The response schema for the getRates operation." + }, + "DirectPurchaseRequest": { + "description": "The request schema for the directPurchaseShipment operation. When the channel type is Amazon, the shipTo address is not required and will be ignored.", + "type": "object", + "required": [ + "channelDetails" + ], + "properties": { + "shipTo": { + "description": "The address where the shipment will be delivered. For vendor orders, shipTo information is pulled directly from the Amazon order.", + "$ref": "#/definitions/Address" + }, + "shipFrom": { + "description": "The address where the package will be picked up.", + "$ref": "#/definitions/Address" + }, + "returnTo": { + "description": "The address where the package will be returned if it cannot be delivered.", + "$ref": "#/definitions/Address" + }, + "packages": { + "$ref": "#/definitions/PackageList" + }, + "channelDetails": { + "$ref": "#/definitions/ChannelDetails" + }, + "labelSpecifications": { + "description": "The document (label) specifications requested. The default label returned is PNG DPI 203 4x6 if no label specification is provided. Requesting an invalid file format results in a failure.", + "$ref": "#/definitions/RequestedDocumentSpecification" + } + } + }, + "DirectPurchaseResult": { + "type": "object", + "required": [ + "shipmentId" + ], + "properties": { + "shipmentId": { + "$ref": "#/definitions/ShipmentId" + }, + "packageDocumentDetailList": { + "$ref": "#/definitions/PackageDocumentDetailList" + } + }, + "description": "The payload for the directPurchaseShipment operation." + }, + "DirectPurchaseResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/DirectPurchaseResult" + } + }, + "description": "The response schema for the directPurchaseShipment operation." + }, + "GetShipmentDocumentsResult": { + "type": "object", + "required": [ + "packageDocumentDetail", + "shipmentId" + ], + "properties": { + "shipmentId": { + "$ref": "#/definitions/ShipmentId" + }, + "packageDocumentDetail": { + "$ref": "#/definitions/PackageDocumentDetail" + } + }, + "description": "The payload for the getShipmentDocuments operation." + }, + "GetShipmentDocumentsResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/GetShipmentDocumentsResult" + } + }, + "description": "The response schema for the the getShipmentDocuments operation." + }, + "GetTrackingResult": { + "type": "object", + "required": [ + "eventHistory", + "promisedDeliveryDate", + "summary", + "trackingId", + "alternateLegTrackingId" + ], + "properties": { + "trackingId": { + "$ref": "#/definitions/TrackingId" + }, + "alternateLegTrackingId": { + "$ref": "#/definitions/AlternateLegTrackingId" + }, + "eventHistory": { + "type": "array", + "description": "A list of tracking events.", + "items": { + "$ref": "#/definitions/Event" + } + }, + "promisedDeliveryDate": { + "type": "string", + "format": "date-time", + "description": "The date and time by which the shipment is promised to be delivered." + }, + "summary": { + "$ref": "#/definitions/TrackingSummary" + } + }, + "description": "The payload for the getTracking operation." + }, + "GetTrackingResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/GetTrackingResult" + } + }, + "description": "The response schema for the getTracking operation." + }, + "PurchaseShipmentRequest": { + "description": "The request schema for the purchaseShipment operation.", + "type": "object", + "required": [ + "rateId", + "requestedDocumentSpecification", + "requestToken" + ], + "properties": { + "requestToken": { + "$ref": "#/definitions/RequestToken" + }, + "rateId": { + "$ref": "#/definitions/RateId" + }, + "requestedDocumentSpecification": { + "$ref": "#/definitions/RequestedDocumentSpecification" + }, + "requestedValueAddedServices": { + "$ref": "#/definitions/RequestedValueAddedServiceList" + }, + "additionalInputs": { + "type": "object", + "additionalProperties" : {}, + "description": "The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation.\n\nAdditional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation." + } + } + }, + "PurchaseShipmentResult": { + "type": "object", + "required": [ + "packageDocumentDetails", + "promise", + "shipmentId" + ], + "properties": { + "shipmentId": { + "$ref": "#/definitions/ShipmentId" + }, + "packageDocumentDetails": { + + "$ref": "#/definitions/PackageDocumentDetailList" + }, + "promise": { + "$ref": "#/definitions/Promise" + } + }, + "description": "The payload for the purchaseShipment operation." + }, + "PurchaseShipmentResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/PurchaseShipmentResult" + } + }, + "description": "The response schema for the purchaseShipment operation." + }, + "GetAdditionalInputsResult": { + "type": "object", + "description": "The JSON schema to use to provide additional inputs when required to purchase a shipping offering.", + "additionalProperties": {} + }, + "GetAdditionalInputsResponse": { + "type": "object", + "properties": { + "payload": { + "$ref": "#/definitions/GetAdditionalInputsResult" + } + }, + "description": "The response schema for the getAdditionalInputs operation." + } + } +} diff --git a/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json b/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json index b6206a5a..7f143251 100644 --- a/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json +++ b/models/vendor-direct-fulfillment-orders-api-model/vendorDirectFulfillmentOrdersV1.json @@ -27,7 +27,7 @@ "/vendor/directFulfillment/orders/v1/purchaseOrders": { "get": { "tags": [ - "vendorOrders" + "vendorOrdersDF" ], "description": "Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrders", @@ -1337,7 +1337,7 @@ "/vendor/directFulfillment/orders/v1/purchaseOrders/{purchaseOrderNumber}": { "get": { "tags": [ - "vendorOrders" + "vendorOrdersDF" ], "description": "Returns purchase order information for the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrder", @@ -1858,7 +1858,7 @@ "/vendor/directFulfillment/orders/v1/acknowledgements": { "post": { "tags": [ - "vendorOrders" + "vendorOrdersDF" ], "description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitAcknowledgement", diff --git a/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json b/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json index 99b9f5ab..245c7909 100644 --- a/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json +++ b/models/vendor-direct-fulfillment-shipping-api-model/vendorDirectFulfillmentShippingV1.json @@ -27,7 +27,7 @@ "/vendor/directFulfillment/shipping/v1/shippingLabels": { "get": { "tags": [ - "vendorShippingLabels" + "vendorShippingLabelsDF" ], "description": "Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getShippingLabels", @@ -417,7 +417,7 @@ }, "post": { "tags": [ - "vendorShippingLabels" + "vendorShippingLabelsDF" ], "description": "Creates a shipping label for a purchase order and returns a transactionId for reference.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitShippingLabelRequest", @@ -782,7 +782,7 @@ "/vendor/directFulfillment/shipping/v1/shippingLabels/{purchaseOrderNumber}": { "get": { "tags": [ - "vendorShippingLabels" + "vendorShippingLabelsDF" ], "description": "Returns a shipping label for the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getShippingLabel", @@ -1048,7 +1048,7 @@ "/vendor/directFulfillment/shipping/v1/shipmentConfirmations": { "post": { "tags": [ - "vendorShipping" + "vendorShippingDF" ], "description": "Submits one or more shipment confirmations for vendor orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitShipmentConfirmations", @@ -1437,7 +1437,7 @@ "/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates": { "post": { "tags": [ - "vendorShipping" + "vendorShippingDF" ], "description": "This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "submitShipmentStatusUpdates", @@ -1685,7 +1685,7 @@ "/vendor/directFulfillment/shipping/v1/customerInvoices": { "get": { "tags": [ - "customerInvoices" + "customerInvoicesDF" ], "description": "Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCustomerInvoices", @@ -2005,7 +2005,7 @@ "/vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber}": { "get": { "tags": [ - "customerInvoices" + "customerInvoicesDF" ], "description": "Returns a customer invoice based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getCustomerInvoice", @@ -2226,7 +2226,7 @@ "/vendor/directFulfillment/shipping/v1/packingSlips": { "get": { "tags": [ - "vendorShipping" + "vendorShippingDF" ], "description": "Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPackingSlips", @@ -2561,7 +2561,7 @@ "/vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber}": { "get": { "tags": [ - "vendorShipping" + "vendorShippingDF" ], "description": "Returns a packing slip based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getPackingSlip", diff --git a/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json b/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json index 4256d587..09d5813d 100644 --- a/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json +++ b/models/vendor-direct-fulfillment-transactions-api-model/vendorDirectFulfillmentTransactionsV1.json @@ -27,7 +27,7 @@ "/vendor/directFulfillment/transactions/v1/transactions/{transactionId}": { "get": { "tags": [ - "vendorTransaction" + "vendorTransactionDF" ], "description": "Returns the status of the transaction indicated by the specified transactionId.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getTransactionStatus",