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

package/dist/types/api-model/models/delivery-information.d.ts

@@ -13,20 +13,11 @@ import type { DeliveryDocument } from './delivery-document';
 import type { DropOffLocation } from './drop-off-location';
 /**
  * The delivery information for the package. This information is available after the package is delivered.
- * @export
- * @interface DeliveryInformation
  */
 export interface DeliveryInformation {
     /**
      * A list of delivery documents for a package.
-     * @type {Array<DeliveryDocument>}
-     * @memberof DeliveryInformation
      */
     'deliveryDocumentList'?: Array<DeliveryDocument>;
-    /**
-     *
-     * @type {DropOffLocation}
-     * @memberof DeliveryInformation
-     */
     'dropOffLocation'?: DropOffLocation;
 }

package/dist/types/api-model/models/delivery-message.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Localized messaging for a delivery offering.
- * @export
- * @interface DeliveryMessage
  */
 export interface DeliveryMessage {
     /**
      * The message content for a delivery offering.
-     * @type {string}
-     * @memberof DeliveryMessage
      */
     'text'?: string;
     /**
-     * The locale for the message (for example, en_US).
-     * @type {string}
-     * @memberof DeliveryMessage
+     * The locale for the message (e.g., `en_US`).
      */
     'locale'?: string;
 }

package/dist/types/api-model/models/delivery-offer.d.ts

@@ -13,26 +13,12 @@ import type { DateRange } from './date-range';
 import type { DeliveryPolicy } from './delivery-policy';
 /**
  * An available offer for delivery of a product.
- * @export
- * @interface DeliveryOffer
  */
 export interface DeliveryOffer {
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof DeliveryOffer
      */
     'expiresAt'?: string;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof DeliveryOffer
-     */
     'dateRange'?: DateRange;
-    /**
-     *
-     * @type {DeliveryPolicy}
-     * @memberof DeliveryOffer
-     */
     'policy'?: DeliveryPolicy;
 }

package/dist/types/api-model/models/delivery-offering.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { DateRange } from './date-range';
+import type { DeliveryPolicy } from './delivery-policy';
+/**
+ * An available offering for delivery of a product.
+ */
+export interface DeliveryOffering {
+    /**
+     * Date timestamp
+     */
+    'expiresAt'?: string;
+    'dateRange'?: DateRange;
+    'policy'?: DeliveryPolicy;
+}

package/dist/types/api-model/models/delivery-policy.d.ts

@@ -12,14 +12,7 @@
 import type { DeliveryMessage } from './delivery-message';
 /**
  * The policy for a delivery offering.
- * @export
- * @interface DeliveryPolicy
  */
 export interface DeliveryPolicy {
-    /**
-     *
-     * @type {DeliveryMessage}
-     * @memberof DeliveryPolicy
-     */
     'message'?: DeliveryMessage;
 }

package/dist/types/api-model/models/delivery-preferences.d.ts

@@ -12,20 +12,11 @@
 import type { DropOffLocation } from './drop-off-location';
 /**
  * The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.
- * @export
- * @interface DeliveryPreferences
  */
 export interface DeliveryPreferences {
     /**
      * Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, \'Beware of dogs\', etc.
-     * @type {string}
-     * @memberof DeliveryPreferences
      */
     'deliveryInstructions'?: string;
-    /**
-     *
-     * @type {DropOffLocation}
-     * @memberof DeliveryPreferences
-     */
     'dropOffLocation'?: DropOffLocation;
 }

package/dist/types/api-model/models/delivery-quantity.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.
+ */
+/**
+ * A quantity based on unit of measure.
+ */
+export interface DeliveryQuantity {
+    /**
+     * The unit of measure for the amount.
+     */
+    'unitOfMeasure': DeliveryQuantityUnitOfMeasureEnum;
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
+     */
+    'amount': string;
+}
+export declare const DeliveryQuantityUnitOfMeasureEnum: {
+    readonly Each: "Each";
+};
+export type DeliveryQuantityUnitOfMeasureEnum = typeof DeliveryQuantityUnitOfMeasureEnum[keyof typeof DeliveryQuantityUnitOfMeasureEnum];

package/dist/types/api-model/models/delivery-window.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace.
- * @export
- * @interface DeliveryWindow
  */
 export interface DeliveryWindow {
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof DeliveryWindow
      */
     'startDate': string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof DeliveryWindow
      */
     'endDate': string;
 }

package/dist/types/api-model/models/destination.d.ts

@@ -12,20 +12,11 @@
 import type { VariablePrecisionAddress } from './variable-precision-address';
 /**
  * The destination for the delivery offer.
- * @export
- * @interface Destination
  */
 export interface Destination {
-    /**
-     *
-     * @type {VariablePrecisionAddress}
-     * @memberof Destination
-     */
     'deliveryAddress'?: VariablePrecisionAddress;
     /**
      * An IP Address.
-     * @type {string}
-     * @memberof Destination
      */
     'ipAddress'?: string;
 }

package/dist/types/api-model/models/drop-off-location.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The preferred location to leave packages at the destination address.
- * @export
- * @interface DropOffLocation
  */
 export interface DropOffLocation {
     /**
      * Specifies the preferred location to leave the package at the destination address.
-     * @type {string}
-     * @memberof DropOffLocation
      */
     'type': DropOffLocationTypeEnum;
     /**
      * Additional information about the drop-off location that can vary depending on the type of drop-off location specified in the `type` field. If the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object should include the exact keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor.
-     * @type {{ [key: string]: string; }}
-     * @memberof DropOffLocation
      */
     'attributes'?: {
         [key: string]: string;

package/dist/types/api-model/models/event-code.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The event code for the delivery event.
- * @export
- * @enum {string}
  */
 export declare const EventCode: {
     readonly Event101: "EVENT_101";

package/dist/types/api-model/models/feature-settings.d.ts

@@ -10,21 +10,15 @@
  * Do not edit the class manually.
  */
 /**
- * `FeatureSettings` allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use `featureName` as `BLOCK_AMZL` and `featureFulfillmentPolicy` as `Required`. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), use featureName `BLANK_BOX`.
- * @export
- * @interface FeatureSettings
+ * Feature settings allows you to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, set `featureName` to `BLOCK_AMZL` and `featureFulfillmentPolicy` to `Required`. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), set `featureName` to `BLANK_BOX`.
  */
 export interface FeatureSettings {
     /**
      * The name of the feature.
-     * @type {string}
-     * @memberof FeatureSettings
      */
     'featureName'?: string;
     /**
      * Specifies the policy to use when fulfilling an order.
-     * @type {string}
-     * @memberof FeatureSettings
      */
     'featureFulfillmentPolicy'?: FeatureSettingsFeatureFulfillmentPolicyEnum;
 }

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

@@ -11,38 +11,26 @@
  */
 /**
  * Information about an SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool.
- * @export
- * @interface FeatureSku
  */
 export interface FeatureSku {
     /**
      * Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s SellerId, which is included with every operation that you submit.
-     * @type {string}
-     * @memberof FeatureSku
      */
     'sellerSku'?: string;
     /**
      * The unique SKU used by Amazon\'s fulfillment network.
-     * @type {string}
-     * @memberof FeatureSku
      */
     'fnSku'?: string;
     /**
      * The Amazon Standard Identification Number (ASIN) of the item.
-     * @type {string}
-     * @memberof FeatureSku
      */
     'asin'?: string;
     /**
      * The number of SKUs available for this service.
-     * @type {number}
-     * @memberof FeatureSku
      */
     'skuCount'?: number;
     /**
      * Other seller SKUs that are shared across the same inventory.
-     * @type {Array<string>}
-     * @memberof FeatureSku
      */
     'overlappingSkus'?: Array<string>;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * A Multi-Channel Fulfillment feature.
- * @export
- * @interface Feature
  */
 export interface Feature {
     /**
      * The feature name.
-     * @type {string}
-     * @memberof Feature
      */
     'featureName': string;
     /**
      * The feature description.
-     * @type {string}
-     * @memberof Feature
      */
     'featureDescription': string;
     /**
      * When true, indicates that the seller is eligible to use the feature.
-     * @type {boolean}
-     * @memberof Feature
      */
     'sellerEligible'?: boolean;
 }

package/dist/types/api-model/models/fee.d.ts

@@ -12,21 +12,12 @@
 import type { Money } from './money';
 /**
  * Fee type and cost.
- * @export
- * @interface Fee
  */
 export interface Fee {
     /**
      * The type of fee.
-     * @type {string}
-     * @memberof Fee
      */
     'name': FeeNameEnum;
-    /**
-     *
-     * @type {Money}
-     * @memberof Fee
-     */
     'amount': Money;
 }
 export declare const FeeNameEnum: {

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

@@ -11,8 +11,6 @@
  */
 /**
  * Specifies whether the fulfillment order should ship now or have an order hold put on it.
- * @export
- * @enum {string}
  */
 export declare const FulfillmentAction: {
     readonly Ship: "Ship";

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

@@ -12,92 +12,53 @@
 import type { Money } from './money';
 /**
  * Item information for a fulfillment order.
- * @export
- * @interface FulfillmentOrderItem
  */
 export interface FulfillmentOrderItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'sellerSku': string;
     /**
      * A fulfillment order item identifier submitted with a call to the `createFulfillmentOrder` operation.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'sellerFulfillmentOrderItemId': string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof FulfillmentOrderItem
      */
     'quantity': number;
     /**
      * A message to the gift recipient, if applicable.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'giftMessage'?: string;
     /**
      * Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'displayableComment'?: string;
     /**
      * Amazon\'s fulfillment network SKU of the item.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'fulfillmentNetworkSku'?: string;
     /**
      * Indicates whether the item is sellable or unsellable.
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'orderItemDisposition'?: string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof FulfillmentOrderItem
      */
     'cancelledQuantity': number;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof FulfillmentOrderItem
      */
     'unfulfillableQuantity': number;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'estimatedShipDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentOrderItem
      */
     'estimatedArrivalDate'?: string;
-    /**
-     *
-     * @type {Money}
-     * @memberof FulfillmentOrderItem
-     */
     'perUnitPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof FulfillmentOrderItem
-     */
     'perUnitTax'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof FulfillmentOrderItem
-     */
     'perUnitDeclaredValue'?: Money;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The current status of the fulfillment order.
- * @export
- * @enum {string}
  */
 export declare const FulfillmentOrderStatus: {
     readonly New: "New";

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

@@ -19,104 +19,49 @@ import type { FulfillmentPolicy } from './fulfillment-policy';
 import type { ShippingSpeedCategory } from './shipping-speed-category';
 /**
  * General information about a fulfillment order, including its status.
- * @export
- * @interface FulfillmentOrder
  */
 export interface FulfillmentOrder {
     /**
      * The fulfillment order identifier submitted with the `createFulfillmentOrder` operation.
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'sellerFulfillmentOrderId': string;
     /**
      * The identifier for the marketplace the fulfillment order is placed against.
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'marketplaceId': string;
     /**
      * A fulfillment order identifier submitted with the `createFulfillmentOrder` operation. Displays as the order identifier in recipient-facing materials such as the packing slip.
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'displayableOrderId': string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'displayableOrderDate': string;
     /**
      * A text block submitted with the `createFulfillmentOrder` operation. Displays in recipient-facing materials such as the packing slip.
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'displayableOrderComment': string;
-    /**
-     *
-     * @type {ShippingSpeedCategory}
-     * @memberof FulfillmentOrder
-     */
     'shippingSpeedCategory': ShippingSpeedCategory;
-    /**
-     *
-     * @type {DeliveryWindow}
-     * @memberof FulfillmentOrder
-     */
     'deliveryWindow'?: DeliveryWindow;
-    /**
-     *
-     * @type {Address}
-     * @memberof FulfillmentOrder
-     */
     'destinationAddress': Address;
-    /**
-     *
-     * @type {FulfillmentAction}
-     * @memberof FulfillmentOrder
-     */
     'fulfillmentAction'?: FulfillmentAction;
-    /**
-     *
-     * @type {FulfillmentPolicy}
-     * @memberof FulfillmentOrder
-     */
     'fulfillmentPolicy'?: FulfillmentPolicy;
-    /**
-     *
-     * @type {CODSettings}
-     * @memberof FulfillmentOrder
-     */
     'codSettings'?: CODSettings;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'receivedDate': string;
-    /**
-     *
-     * @type {FulfillmentOrderStatus}
-     * @memberof FulfillmentOrder
-     */
     'fulfillmentOrderStatus': FulfillmentOrderStatus;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentOrder
      */
     'statusUpdatedDate': string;
     /**
      * A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.
-     * @type {Array<string>}
-     * @memberof FulfillmentOrder
      */
     'notificationEmails'?: Array<string>;
     /**
      * A list of features and their fulfillment policies to apply to the order.
-     * @type {Array<FeatureSettings>}
-     * @memberof FulfillmentOrder
      */
     'featureConstraints'?: Array<FeatureSettings>;
 }

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

@@ -10,9 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * The `FulfillmentPolicy` value specified when you submitted the `createFulfillmentOrder` operation.
- * @export
- * @enum {string}
+ * The `FulfillmentPolicy` value specified when you called the `createFulfillmentOrder` operation.
  */
 export declare const FulfillmentPolicy: {
     readonly FillOrKill: "FillOrKill";

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

@@ -12,38 +12,23 @@
 import type { Weight } from './weight';
 /**
  * Item information for a shipment in a fulfillment order preview.
- * @export
- * @interface FulfillmentPreviewItem
  */
 export interface FulfillmentPreviewItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof FulfillmentPreviewItem
      */
     'sellerSku': string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof FulfillmentPreviewItem
      */
     'quantity': number;
     /**
      * A fulfillment order item identifier that the seller created with a call to the `createFulfillmentOrder` operation.
-     * @type {string}
-     * @memberof FulfillmentPreviewItem
      */
     'sellerFulfillmentOrderItemId': string;
-    /**
-     *
-     * @type {Weight}
-     * @memberof FulfillmentPreviewItem
-     */
     'estimatedShippingWeight'?: Weight;
     /**
      * The method used to calculate the estimated shipping weight.
-     * @type {string}
-     * @memberof FulfillmentPreviewItem
      */
     'shippingWeightCalculationMethod'?: FulfillmentPreviewItemShippingWeightCalculationMethodEnum;
 }

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

@@ -12,44 +12,30 @@
 import type { FulfillmentPreviewItem } from './fulfillment-preview-item';
 /**
  * Delivery and item information for a shipment in a fulfillment order preview.
- * @export
- * @interface FulfillmentPreviewShipment
  */
 export interface FulfillmentPreviewShipment {
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentPreviewShipment
      */
     'earliestShipDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentPreviewShipment
      */
     'latestShipDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentPreviewShipment
      */
     'earliestArrivalDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof FulfillmentPreviewShipment
      */
     'latestArrivalDate'?: string;
     /**
      * Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed.
-     * @type {Array<string>}
-     * @memberof FulfillmentPreviewShipment
      */
     'shippingNotes'?: Array<string>;
     /**
      * An array of fulfillment preview item information.
-     * @type {Array<FulfillmentPreviewItem>}
-     * @memberof FulfillmentPreviewShipment
      */
     'fulfillmentPreviewItems': Array<FulfillmentPreviewItem>;
 }