@sp-api-sdk/fulfillment-outbound-api-2020-07-01 4.0.1 → 4.1.0

package/dist/types/api-model/models/fulfillment-preview.d.ts

@@ -18,74 +18,41 @@ import type { UnfulfillablePreviewItem } from './unfulfillable-preview-item';
 import type { Weight } from './weight';
 /**
  * Information about a fulfillment order preview, including delivery and fee information based on shipping method.
- * @export
- * @interface FulfillmentPreview
  */
 export interface FulfillmentPreview {
-    /**
-     *
-     * @type {ShippingSpeedCategory}
-     * @memberof FulfillmentPreview
-     */
     'shippingSpeedCategory': ShippingSpeedCategory;
-    /**
-     *
-     * @type {ScheduledDeliveryInfo}
-     * @memberof FulfillmentPreview
-     */
     'scheduledDeliveryInfo'?: ScheduledDeliveryInfo;
     /**
      * When true, this fulfillment order preview is fulfillable.
-     * @type {boolean}
-     * @memberof FulfillmentPreview
      */
     'isFulfillable': boolean;
     /**
      * When true, this fulfillment order preview is for COD (Cash On Delivery).
-     * @type {boolean}
-     * @memberof FulfillmentPreview
      */
     'isCODCapable': boolean;
-    /**
-     *
-     * @type {Weight}
-     * @memberof FulfillmentPreview
-     */
     'estimatedShippingWeight'?: Weight;
     /**
      * An array of fee type and cost pairs.
-     * @type {Array<Fee>}
-     * @memberof FulfillmentPreview
      */
     'estimatedFees'?: Array<Fee>;
     /**
      * An array of fulfillment preview shipment information.
-     * @type {Array<FulfillmentPreviewShipment>}
-     * @memberof FulfillmentPreview
      */
     'fulfillmentPreviewShipments'?: Array<FulfillmentPreviewShipment>;
     /**
      * An array of unfulfillable preview item information.
-     * @type {Array<UnfulfillablePreviewItem>}
-     * @memberof FulfillmentPreview
      */
     'unfulfillablePreviewItems'?: Array<UnfulfillablePreviewItem>;
     /**
      * String list
-     * @type {Array<string>}
-     * @memberof FulfillmentPreview
      */
     'orderUnfulfillableReasons'?: Array<string>;
     /**
      * The marketplace the fulfillment order is placed against.
-     * @type {string}
-     * @memberof FulfillmentPreview
      */
     'marketplaceId': string;
     /**
      * A list of features and their fulfillment policies to apply to the order.
-     * @type {Array<FeatureSettings>}
-     * @memberof FulfillmentPreview
      */
     'featureConstraints'?: Array<FeatureSettings>;
 }

package/dist/types/api-model/models/fulfillment-return-item-status.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Indicates if the return item has been processed by a fulfillment center.
- * @export
- * @enum {string}
  */
 export declare const FulfillmentReturnItemStatus: {
     readonly New: "New";

package/dist/types/api-model/models/fulfillment-shipment-item.d.ts

@@ -11,44 +11,30 @@
  */
 /**
  * Item information for a shipment in a fulfillment order.
- * @export
- * @interface FulfillmentShipmentItem
  */
 export interface FulfillmentShipmentItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof FulfillmentShipmentItem
      */
     'sellerSku': string;
     /**
      * The fulfillment order item identifier that the seller created and submitted with a call to the `createFulfillmentOrder` operation.
-     * @type {string}
-     * @memberof FulfillmentShipmentItem
      */
     'sellerFulfillmentOrderItemId': string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof FulfillmentShipmentItem
      */
     'quantity': number;
     /**
      * An identifier for the package that contains the item quantity.
-     * @type {number}
-     * @memberof FulfillmentShipmentItem
      */
     'packageNumber'?: number;
     /**
      * The serial number of the shipped item.
-     * @type {string}
-     * @memberof FulfillmentShipmentItem
      */
     'serialNumber'?: string;
     /**
      * String list
-     * @type {Array<string>}
-     * @memberof FulfillmentShipmentItem
      */
     'manufacturerLotCodes'?: Array<string>;
 }

package/dist/types/api-model/models/fulfillment-shipment-package.d.ts

@@ -13,44 +13,28 @@ import type { DeliveryInformation } from './delivery-information';
 import type { LockerDetails } from './locker-details';
 /**
  * Package information for a shipment in a fulfillment order.
- * @export
- * @interface FulfillmentShipmentPackage
  */
 export interface FulfillmentShipmentPackage {
     /**
      * Identifies a package in a shipment.
-     * @type {number}
-     * @memberof FulfillmentShipmentPackage
      */
     'packageNumber': number;
     /**
      * Identifies the carrier who will deliver the shipment to the recipient.
-     * @type {string}
-     * @memberof FulfillmentShipmentPackage
      */
     'carrierCode': string;
     /**
      * The tracking number, if provided, can be used to obtain tracking and delivery information.
-     * @type {string}
-     * @memberof FulfillmentShipmentPackage
      */
     'trackingNumber'?: string;
     /**
-     * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentShipmentPackage
+     * The Amazon fulfillment tracking number, if provided, can be used to obtain tracking and delivery information.
      */
-    'estimatedArrivalDate'?: string;
+    'amazonFulfillmentTrackingNumber'?: string;
     /**
-     *
-     * @type {LockerDetails}
-     * @memberof FulfillmentShipmentPackage
+     * Date timestamp
      */
+    'estimatedArrivalDate'?: string;
     'lockerDetails'?: LockerDetails;
-    /**
-     *
-     * @type {DeliveryInformation}
-     * @memberof FulfillmentShipmentPackage
-     */
     'deliveryInformation'?: DeliveryInformation;
 }

package/dist/types/api-model/models/fulfillment-shipment.d.ts

@@ -13,56 +13,38 @@ import type { FulfillmentShipmentItem } from './fulfillment-shipment-item';
 import type { FulfillmentShipmentPackage } from './fulfillment-shipment-package';
 /**
  * Delivery and item information for a shipment in a fulfillment order.
- * @export
- * @interface FulfillmentShipment
  */
 export interface FulfillmentShipment {
     /**
      * A shipment identifier assigned by Amazon.
-     * @type {string}
-     * @memberof FulfillmentShipment
      */
     'amazonShipmentId': string;
     /**
-     * An identifier for the fulfillment center that the shipment will be sent from.
-     * @type {string}
-     * @memberof FulfillmentShipment
+     * An identifier for the fulfillment center from which the shipment is sent.
      */
     'fulfillmentCenterId': string;
     /**
      * The current status of the shipment.
-     * @type {string}
-     * @memberof FulfillmentShipment
      */
     'fulfillmentShipmentStatus': FulfillmentShipmentFulfillmentShipmentStatusEnum;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentShipment
      */
     'shippingDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentShipment
      */
     'estimatedArrivalDate'?: string;
     /**
-     * Provides additional insight into shipment timeline. Primairly used to communicate that actual delivery dates aren\'t available.
-     * @type {Array<string>}
-     * @memberof FulfillmentShipment
+     * Provides additional insight into shipment timeline. Primarily used to communicate that actual delivery dates aren\'t available.
      */
     'shippingNotes'?: Array<string>;
     /**
      * An array of fulfillment shipment item information.
-     * @type {Array<FulfillmentShipmentItem>}
-     * @memberof FulfillmentShipment
      */
     'fulfillmentShipmentItem': Array<FulfillmentShipmentItem>;
     /**
      * An array of fulfillment shipment package information.
-     * @type {Array<FulfillmentShipmentPackage>}
-     * @memberof FulfillmentShipment
      */
     'fulfillmentShipmentPackage'?: Array<FulfillmentShipmentPackage>;
 }

package/dist/types/api-model/models/get-delivery-offerings-request.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Selling Partner APIs for Fulfillment Outbound
+ * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
+ *
+ * The version of the OpenAPI document: 2020-07-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DeliveryQuantity } from './delivery-quantity';
+import type { VariablePrecisionAddress } from './variable-precision-address';
+/**
+ * The request body schema for the `getDeliveryOfferings` operation.
+ */
+export interface GetDeliveryOfferingsRequest {
+    'destinationAddress': VariablePrecisionAddress;
+    /**
+     * The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format.
+     */
+    'shipFromCountryCode': string;
+    /**
+     * The seller SKU of the item.
+     */
+    'sellerSku': string;
+    'quantity'?: DeliveryQuantity;
+}

package/dist/types/api-model/models/get-delivery-offerings-response.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Selling Partner APIs for Fulfillment Outbound
+ * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
+ *
+ * The version of the OpenAPI document: 2020-07-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { GetDeliveryOfferingsResult } from './get-delivery-offerings-result';
+/**
+ * The response schema for the `getDeliveryOfferings` operation.
+ */
+export interface GetDeliveryOfferingsResponse {
+    'payload'?: GetDeliveryOfferingsResult;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/api-model/models/get-delivery-offerings-result.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Selling Partner APIs for Fulfillment Outbound
+ * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
+ *
+ * The version of the OpenAPI document: 2020-07-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DeliveryOffering } from './delivery-offering';
+/**
+ * A list of delivery offerings, including offering expiration, earliest and latest date and time range, and the delivery offering policy.
+ */
+export interface GetDeliveryOfferingsResult {
+    /**
+     * An array of delivery offering information.
+     */
+    'deliveryOfferings'?: Array<DeliveryOffering>;
+}

package/dist/types/api-model/models/get-delivery-offers-product.d.ts

@@ -13,20 +13,8 @@ import type { Amount } from './amount';
 import type { ProductIdentifier } from './product-identifier';
 /**
  * The product details for the delivery offer.
- * @export
- * @interface GetDeliveryOffersProduct
  */
 export interface GetDeliveryOffersProduct {
-    /**
-     *
-     * @type {ProductIdentifier}
-     * @memberof GetDeliveryOffersProduct
-     */
     'productIdentifier': ProductIdentifier;
-    /**
-     *
-     * @type {Amount}
-     * @memberof GetDeliveryOffersProduct
-     */
     'amount'?: Amount;
 }

package/dist/types/api-model/models/get-delivery-offers-request.d.ts

@@ -12,21 +12,9 @@
 import type { GetDeliveryOffersProduct } from './get-delivery-offers-product';
 import type { GetDeliveryOffersTerms } from './get-delivery-offers-terms';
 /**
- * The request body schema for the getDeliveryOffers operation.
- * @export
- * @interface GetDeliveryOffersRequest
+ * The request body schema for the `getDeliveryOffers` operation.
  */
 export interface GetDeliveryOffersRequest {
-    /**
-     *
-     * @type {GetDeliveryOffersProduct}
-     * @memberof GetDeliveryOffersRequest
-     */
     'product': GetDeliveryOffersProduct;
-    /**
-     *
-     * @type {GetDeliveryOffersTerms}
-     * @memberof GetDeliveryOffersRequest
-     */
     'terms': GetDeliveryOffersTerms;
 }

package/dist/types/api-model/models/get-delivery-offers-response.d.ts

@@ -11,21 +11,12 @@
  */
 import type { GetDeliveryOffersResult } from './get-delivery-offers-result';
 /**
- * The response schema for the getDeliveryOffers operation.
- * @export
- * @interface GetDeliveryOffersResponse
+ * The response schema for the `getDeliveryOffers` operation.
  */
 export interface GetDeliveryOffersResponse {
-    /**
-     *
-     * @type {GetDeliveryOffersResult}
-     * @memberof GetDeliveryOffersResponse
-     */
     'payload'?: GetDeliveryOffersResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetDeliveryOffersResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-delivery-offers-result.d.ts

@@ -12,14 +12,10 @@
 import type { DeliveryOffer } from './delivery-offer';
 /**
  * A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy.
- * @export
- * @interface GetDeliveryOffersResult
  */
 export interface GetDeliveryOffersResult {
     /**
      * An array of delivery offer information.
-     * @type {Array<DeliveryOffer>}
-     * @memberof GetDeliveryOffersResult
      */
     'deliveryOffers'?: Array<DeliveryOffer>;
 }

package/dist/types/api-model/models/get-delivery-offers-terms.d.ts

@@ -13,20 +13,8 @@ import type { Destination } from './destination';
 import type { Origin } from './origin';
 /**
  * The delivery terms for the delivery offer.
- * @export
- * @interface GetDeliveryOffersTerms
  */
 export interface GetDeliveryOffersTerms {
-    /**
-     *
-     * @type {Origin}
-     * @memberof GetDeliveryOffersTerms
-     */
     'origin': Origin;
-    /**
-     *
-     * @type {Destination}
-     * @memberof GetDeliveryOffersTerms
-     */
     'destination': Destination;
 }

package/dist/types/api-model/models/get-feature-inventory-response.d.ts

@@ -12,20 +12,11 @@
 import type { GetFeatureInventoryResult } from './get-feature-inventory-result';
 /**
  * The breakdown of eligibility inventory by feature.
- * @export
- * @interface GetFeatureInventoryResponse
  */
 export interface GetFeatureInventoryResponse {
-    /**
-     *
-     * @type {GetFeatureInventoryResult}
-     * @memberof GetFeatureInventoryResponse
-     */
     'payload'?: GetFeatureInventoryResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetFeatureInventoryResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-feature-inventory-result.d.ts

@@ -11,33 +11,23 @@
  */
 import type { FeatureSku } from './feature-sku';
 /**
- * The payload for the `getEligibileInventory` operation.
- * @export
- * @interface GetFeatureInventoryResult
+ * The payload for the `getEligibleInventory` operation.
  */
 export interface GetFeatureInventoryResult {
     /**
      * The requested marketplace.
-     * @type {string}
-     * @memberof GetFeatureInventoryResult
      */
     'marketplaceId': string;
     /**
      * The name of the feature.
-     * @type {string}
-     * @memberof GetFeatureInventoryResult
      */
     'featureName': string;
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof GetFeatureInventoryResult
      */
     'nextToken'?: string;
     /**
      * An array of SKUs eligible for this feature and the quantity available.
-     * @type {Array<FeatureSku>}
-     * @memberof GetFeatureInventoryResult
      */
     'featureSkus'?: Array<FeatureSku>;
 }

package/dist/types/api-model/models/get-feature-sku-response.d.ts

@@ -12,20 +12,11 @@
 import type { GetFeatureSkuResult } from './get-feature-sku-result';
 /**
  * The response schema for the `getFeatureSKU` operation.
- * @export
- * @interface GetFeatureSkuResponse
  */
 export interface GetFeatureSkuResponse {
-    /**
-     *
-     * @type {GetFeatureSkuResult}
-     * @memberof GetFeatureSkuResponse
-     */
     'payload'?: GetFeatureSkuResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetFeatureSkuResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-feature-sku-result.d.ts

@@ -12,38 +12,23 @@
 import type { FeatureSku } from './feature-sku';
 /**
  * The payload for the `getFeatureSKU` operation.
- * @export
- * @interface GetFeatureSkuResult
  */
 export interface GetFeatureSkuResult {
     /**
      * The requested marketplace.
-     * @type {string}
-     * @memberof GetFeatureSkuResult
      */
     'marketplaceId': string;
     /**
      * The name of the feature.
-     * @type {string}
-     * @memberof GetFeatureSkuResult
      */
     'featureName': string;
     /**
      * When true, the seller SKU is eligible for the requested feature.
-     * @type {boolean}
-     * @memberof GetFeatureSkuResult
      */
     'isEligible': boolean;
     /**
-     * A list of one or more reasons that the seller SKU is ineligibile for the feature.  Possible values: * `MERCHANT_NOT_ENROLLED` - The merchant isn\'t enrolled for the feature. * `SKU_NOT_ELIGIBLE` - The SKU doesn\'t reside in a warehouse that supports the feature. * `INVALID_SKU` - There is an issue with the SKU provided.
-     * @type {Array<string>}
-     * @memberof GetFeatureSkuResult
+     * A list of one or more reasons that the seller SKU is ineligible for the feature.  Possible values: * `MERCHANT_NOT_ENROLLED`: The merchant isn\'t enrolled for the feature. * `SKU_NOT_ELIGIBLE`: The SKU doesn\'t reside in a warehouse that supports the feature. * `INVALID_SKU`: There is an issue with the SKU provided.
      */
     'ineligibleReasons'?: Array<string>;
-    /**
-     *
-     * @type {FeatureSku}
-     * @memberof GetFeatureSkuResult
-     */
     'skuInfo'?: FeatureSku;
 }

package/dist/types/api-model/models/get-features-response.d.ts

@@ -12,20 +12,11 @@
 import type { GetFeaturesResult } from './get-features-result';
 /**
  * The response schema for the `getFeatures` operation.
- * @export
- * @interface GetFeaturesResponse
  */
 export interface GetFeaturesResponse {
-    /**
-     *
-     * @type {GetFeaturesResult}
-     * @memberof GetFeaturesResponse
-     */
     'payload'?: GetFeaturesResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetFeaturesResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-features-result.d.ts

@@ -12,14 +12,10 @@
 import type { Feature } from './feature';
 /**
  * The payload for the `getFeatures` operation.
- * @export
- * @interface GetFeaturesResult
  */
 export interface GetFeaturesResult {
     /**
      * An array of features.
-     * @type {Array<Feature>}
-     * @memberof GetFeaturesResult
      */
     'features': Array<Feature>;
 }

package/dist/types/api-model/models/get-fulfillment-order-response.d.ts

@@ -12,20 +12,11 @@
 import type { GetFulfillmentOrderResult } from './get-fulfillment-order-result';
 /**
  * The response schema for the `getFulfillmentOrder` operation.
- * @export
- * @interface GetFulfillmentOrderResponse
  */
 export interface GetFulfillmentOrderResponse {
-    /**
-     *
-     * @type {GetFulfillmentOrderResult}
-     * @memberof GetFulfillmentOrderResponse
-     */
     'payload'?: GetFulfillmentOrderResult;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetFulfillmentOrderResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/get-fulfillment-order-result.d.ts

@@ -16,45 +16,28 @@ import type { PaymentInformation } from './payment-information';
 import type { ReturnAuthorization } from './return-authorization';
 import type { ReturnItem } from './return-item';
 /**
- * The request for the getFulfillmentOrder operation.
- * @export
- * @interface GetFulfillmentOrderResult
+ * The request for the `getFulfillmentOrder` operation.
  */
 export interface GetFulfillmentOrderResult {
-    /**
-     *
-     * @type {FulfillmentOrder}
-     * @memberof GetFulfillmentOrderResult
-     */
     'fulfillmentOrder': FulfillmentOrder;
     /**
      * An array of fulfillment order item information.
-     * @type {Array<FulfillmentOrderItem>}
-     * @memberof GetFulfillmentOrderResult
      */
     'fulfillmentOrderItems': Array<FulfillmentOrderItem>;
     /**
      * An array of fulfillment shipment information.
-     * @type {Array<FulfillmentShipment>}
-     * @memberof GetFulfillmentOrderResult
      */
     'fulfillmentShipments'?: Array<FulfillmentShipment>;
     /**
      * An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.
-     * @type {Array<ReturnItem>}
-     * @memberof GetFulfillmentOrderResult
      */
     'returnItems': Array<ReturnItem>;
     /**
      * An array of return authorization information.
-     * @type {Array<ReturnAuthorization>}
-     * @memberof GetFulfillmentOrderResult
      */
     'returnAuthorizations': Array<ReturnAuthorization>;
     /**
      * An array of various payment attributes related to this fulfillment order.
-     * @type {Array<PaymentInformation>}
-     * @memberof GetFulfillmentOrderResult
      */
     'paymentInformation'?: Array<PaymentInformation>;
 }