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

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

@@ -12,32 +12,19 @@
 import type { Money } from './money';
 /**
  * Item information for a fulfillment order preview.
- * @export
- * @interface GetFulfillmentPreviewItem
  */
 export interface GetFulfillmentPreviewItem {
     /**
      * The seller SKU of the item.
-     * @type {string}
-     * @memberof GetFulfillmentPreviewItem
      */
     'sellerSku': string;
     /**
      * The item quantity.
-     * @type {number}
-     * @memberof GetFulfillmentPreviewItem
      */
     'quantity': number;
-    /**
-     *
-     * @type {Money}
-     * @memberof GetFulfillmentPreviewItem
-     */
     'perUnitDeclaredValue'?: Money;
     /**
      * A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.
-     * @type {string}
-     * @memberof GetFulfillmentPreviewItem
      */
     'sellerFulfillmentOrderItemId': string;
 }

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

@@ -15,50 +15,31 @@ import type { GetFulfillmentPreviewItem } from './get-fulfillment-preview-item';
 import type { ShippingSpeedCategory } from './shipping-speed-category';
 /**
  * The request body schema for the `getFulfillmentPreview` operation.
- * @export
- * @interface GetFulfillmentPreviewRequest
  */
 export interface GetFulfillmentPreviewRequest {
     /**
      * The marketplace the fulfillment order is placed against.
-     * @type {string}
-     * @memberof GetFulfillmentPreviewRequest
      */
     'marketplaceId'?: string;
-    /**
-     *
-     * @type {Address}
-     * @memberof GetFulfillmentPreviewRequest
-     */
     'address': Address;
     /**
      * An array of fulfillment preview item information.
-     * @type {Array<GetFulfillmentPreviewItem>}
-     * @memberof GetFulfillmentPreviewRequest
      */
     'items': Array<GetFulfillmentPreviewItem>;
     /**
-     * ShippingSpeedCategory List
-     * @type {Array<ShippingSpeedCategory>}
-     * @memberof GetFulfillmentPreviewRequest
+     * List of shipping speed categories.
      */
     'shippingSpeedCategories'?: Array<ShippingSpeedCategory>;
     /**
      * When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD.
-     * @type {boolean}
-     * @memberof GetFulfillmentPreviewRequest
      */
     'includeCODFulfillmentPreview'?: boolean;
     /**
-     * When true, returns the `ScheduledDeliveryInfo` response object, which contains the available delivery windows for a Scheduled Delivery. The `ScheduledDeliveryInfo` response object can only be returned for fulfillment order previews with `ShippingSpeedCategories` = `ScheduledDelivery`.
-     * @type {boolean}
-     * @memberof GetFulfillmentPreviewRequest
+     * When true, returns the `ScheduledDeliveryInfo` response object, which contains the available delivery windows for a Scheduled Delivery. The `ScheduledDeliveryInfo` response object can only be returned for fulfillment order previews with `ShippingSpeedCategories` equal to `ScheduledDelivery`.
      */
     'includeDeliveryWindows'?: boolean;
     /**
      * A list of features and their fulfillment policies to apply to the order.
-     * @type {Array<FeatureSettings>}
-     * @memberof GetFulfillmentPreviewRequest
      */
     'featureConstraints'?: Array<FeatureSettings>;
 }

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

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

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

@@ -12,14 +12,10 @@
 import type { FulfillmentPreview } from './fulfillment-preview';
 /**
  * A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates.
- * @export
- * @interface GetFulfillmentPreviewResult
  */
 export interface GetFulfillmentPreviewResult {
     /**
      * An array of fulfillment preview information.
-     * @type {Array<FulfillmentPreview>}
-     * @memberof GetFulfillmentPreviewResult
      */
     'fulfillmentPreviews'?: Array<FulfillmentPreview>;
 }

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

@@ -12,20 +12,11 @@
 import type { PackageTrackingDetails } from './package-tracking-details';
 /**
  * The response schema for the `getPackageTrackingDetails` operation.
- * @export
- * @interface GetPackageTrackingDetailsResponse
  */
 export interface GetPackageTrackingDetailsResponse {
-    /**
-     *
-     * @type {PackageTrackingDetails}
-     * @memberof GetPackageTrackingDetailsResponse
-     */
     'payload'?: PackageTrackingDetails;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof GetPackageTrackingDetailsResponse
      */
     'errors'?: Array<Error>;
 }

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

@@ -16,8 +16,10 @@ export * from './delivery-document';
 export * from './delivery-information';
 export * from './delivery-message';
 export * from './delivery-offer';
+export * from './delivery-offering';
 export * from './delivery-policy';
 export * from './delivery-preferences';
+export * from './delivery-quantity';
 export * from './delivery-window';
 export * from './destination';
 export * from './drop-off-location';
@@ -38,6 +40,9 @@ export * from './fulfillment-return-item-status';
 export * from './fulfillment-shipment';
 export * from './fulfillment-shipment-item';
 export * from './fulfillment-shipment-package';
+export * from './get-delivery-offerings-request';
+export * from './get-delivery-offerings-response';
+export * from './get-delivery-offerings-result';
 export * from './get-delivery-offers-product';
 export * from './get-delivery-offers-request';
 export * from './get-delivery-offers-response';

package/dist/types/api-model/models/invalid-item-reason-code.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * A code for why the item is invalid for return.
- * @export
- * @enum {string}
  */
 export declare const InvalidItemReasonCode: {
     readonly InvalidValues: "InvalidValues";

package/dist/types/api-model/models/invalid-item-reason.d.ts

@@ -12,20 +12,11 @@
 import type { InvalidItemReasonCode } from './invalid-item-reason-code';
 /**
  * The reason that the item is invalid for return.
- * @export
- * @interface InvalidItemReason
  */
 export interface InvalidItemReason {
-    /**
-     *
-     * @type {InvalidItemReasonCode}
-     * @memberof InvalidItemReason
-     */
     'invalidItemReasonCode': InvalidItemReasonCode;
     /**
      * A human readable description of the invalid item reason code.
-     * @type {string}
-     * @memberof InvalidItemReason
      */
     'description': string;
 }

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

@@ -12,26 +12,15 @@
 import type { InvalidItemReason } from './invalid-item-reason';
 /**
  * An item that is invalid for return.
- * @export
- * @interface InvalidReturnItem
  */
 export interface InvalidReturnItem {
     /**
-     * An identifier assigned by the seller to the return item.
-     * @type {string}
-     * @memberof InvalidReturnItem
+     * An identifier the seller assigns to the return item.
      */
     'sellerReturnItemId': string;
     /**
      * The identifier assigned to the item by the seller when the fulfillment order was created.
-     * @type {string}
-     * @memberof InvalidReturnItem
      */
     'sellerFulfillmentOrderItemId': string;
-    /**
-     *
-     * @type {InvalidItemReason}
-     * @memberof InvalidReturnItem
-     */
     'invalidItemReason': InvalidItemReason;
 }

package/dist/types/api-model/models/list-all-fulfillment-orders-response.d.ts

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

package/dist/types/api-model/models/list-all-fulfillment-orders-result.d.ts

@@ -11,21 +11,15 @@
  */
 import type { FulfillmentOrder } from './fulfillment-order';
 /**
- * The request for the listAllFulfillmentOrders operation.
- * @export
- * @interface ListAllFulfillmentOrdersResult
+ * The request for the `listAllFulfillmentOrders` operation.
  */
 export interface ListAllFulfillmentOrdersResult {
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof ListAllFulfillmentOrdersResult
      */
     'nextToken'?: string;
     /**
      * An array of fulfillment order information.
-     * @type {Array<FulfillmentOrder>}
-     * @memberof ListAllFulfillmentOrdersResult
      */
     'fulfillmentOrders'?: Array<FulfillmentOrder>;
 }

package/dist/types/api-model/models/list-return-reason-codes-response.d.ts

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

package/dist/types/api-model/models/list-return-reason-codes-result.d.ts

@@ -11,15 +11,11 @@
  */
 import type { ReasonCodeDetails } from './reason-code-details';
 /**
- * The request for the listReturnReasonCodes operation.
- * @export
- * @interface ListReturnReasonCodesResult
+ * The request for the `listReturnReasonCodes` operation.
  */
 export interface ListReturnReasonCodesResult {
     /**
      * An array of return reason code details.
-     * @type {Array<ReasonCodeDetails>}
-     * @memberof ListReturnReasonCodesResult
      */
     'reasonCodeDetails'?: Array<ReasonCodeDetails>;
 }

package/dist/types/api-model/models/locker-details.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The locker details, which you can use to access the locker delivery box.
- * @export
- * @interface LockerDetails
  */
 export interface LockerDetails {
     /**
      * Indicates the locker number
-     * @type {string}
-     * @memberof LockerDetails
      */
     'lockerNumber'?: string;
     /**
      * Indicates the locker access code
-     * @type {string}
-     * @memberof LockerDetails
      */
     'lockerAccessCode'?: string;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * Error response returned when the request is unsuccessful.
- * @export
- * @interface ModelError
  */
 export interface ModelError {
     /**
      * An error code that identifies the type of error that occurred.
-     * @type {string}
-     * @memberof ModelError
      */
     'code': string;
     /**
      * A message that describes the error condition.
-     * @type {string}
-     * @memberof ModelError
      */
     'message': string;
     /**
      * Additional details that can help the caller understand or fix the issue.
-     * @type {string}
-     * @memberof ModelError
      */
     'details'?: string;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * An amount of money, including units in the form of currency.
- * @export
- * @interface Money
  */
 export interface Money {
     /**
      * Three digit currency code in ISO 4217 format.
-     * @type {string}
-     * @memberof Money
      */
     'currencyCode': string;
     /**
      * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
-     * @type {string}
-     * @memberof Money
      */
     'value': string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The origin for the delivery offer.
- * @export
- * @interface Origin
  */
 export interface Origin {
     /**
      * The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Origin
      */
     'countryCode': string;
 }

package/dist/types/api-model/models/package-tracking-details.d.ts

@@ -16,98 +16,54 @@ import type { TrackingAddress } from './tracking-address';
 import type { TrackingEvent } from './tracking-event';
 /**
  * Tracking details of package
- * @export
- * @interface PackageTrackingDetails
  */
 export interface PackageTrackingDetails {
     /**
      * The package identifier.
-     * @type {number}
-     * @memberof PackageTrackingDetails
      */
     'packageNumber': number;
     /**
      * The tracking number for the package.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'trackingNumber'?: string;
     /**
      * Link on swiship.com that allows customers to track the package.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'customerTrackingLink'?: string;
     /**
      * The name of the carrier.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'carrierCode'?: string;
     /**
      * The phone number of the carrier.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'carrierPhoneNumber'?: string;
     /**
      * The URL of the carrier\'s website.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'carrierURL'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'shipDate'?: string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'estimatedArrivalDate'?: string;
-    /**
-     *
-     * @type {TrackingAddress}
-     * @memberof PackageTrackingDetails
-     */
     'shipToAddress'?: TrackingAddress;
-    /**
-     *
-     * @type {CurrentStatus}
-     * @memberof PackageTrackingDetails
-     */
     'currentStatus'?: CurrentStatus;
     /**
-     * Description corresponding to the CurrentStatus value.
-     * @type {string}
-     * @memberof PackageTrackingDetails
+     * Description corresponding to the `CurrentStatus` value.
      */
     'currentStatusDescription'?: string;
-    /**
-     *
-     * @type {DateRange}
-     * @memberof PackageTrackingDetails
-     */
     'deliveryWindow'?: DateRange;
     /**
      * The name of the person who signed for the package.
-     * @type {string}
-     * @memberof PackageTrackingDetails
      */
     'signedForBy'?: string;
-    /**
-     *
-     * @type {AdditionalLocationInfo}
-     * @memberof PackageTrackingDetails
-     */
     'additionalLocationInfo'?: AdditionalLocationInfo;
     /**
      * An array of tracking event information.
-     * @type {Array<TrackingEvent>}
-     * @memberof PackageTrackingDetails
      */
     'trackingEvents'?: Array<TrackingEvent>;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * The attributes related to the payment made from customer to seller for this order.
- * @export
- * @interface PaymentInformation
  */
 export interface PaymentInformation {
     /**
      * The transaction identifier of this payment.
-     * @type {string}
-     * @memberof PaymentInformation
      */
     'paymentTransactionId': string;
     /**
      * The transaction mode of this payment.
-     * @type {string}
-     * @memberof PaymentInformation
      */
     'paymentMode': string;
     /**
      * Date timestamp
-     * @type {string}
-     * @memberof PaymentInformation
      */
     'paymentDate': string;
 }

package/dist/types/api-model/models/product-identifier.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Product identifier input that locates a product for MCF.
- * @export
- * @interface ProductIdentifier
  */
 export interface ProductIdentifier {
     /**
      * The merchant SKU for the product.
-     * @type {string}
-     * @memberof ProductIdentifier
      */
     'merchantSku': string;
 }

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

@@ -11,26 +11,18 @@
  */
 /**
  * A return reason code, a description, and an optional description translation.
- * @export
- * @interface ReasonCodeDetails
  */
 export interface ReasonCodeDetails {
     /**
      * A code that indicates a valid return reason.
-     * @type {string}
-     * @memberof ReasonCodeDetails
      */
     'returnReasonCode': string;
     /**
      * A human readable description of the return reason code.
-     * @type {string}
-     * @memberof ReasonCodeDetails
      */
     'description': string;
     /**
-     * A translation of the description. The translation is in the language specified in the Language request parameter.
-     * @type {string}
-     * @memberof ReasonCodeDetails
+     * A translation of the description. The translation is in the language specified in the `language` request parameter.
      */
     'translatedDescription'?: string;
 }

package/dist/types/api-model/models/return-authorization.d.ts

@@ -12,38 +12,23 @@
 import type { Address } from './address';
 /**
  * Return authorization information for items accepted for return.
- * @export
- * @interface ReturnAuthorization
  */
 export interface ReturnAuthorization {
     /**
      * An identifier for the return authorization. This identifier associates return items with the return authorization used to return them.
-     * @type {string}
-     * @memberof ReturnAuthorization
      */
     'returnAuthorizationId': string;
     /**
-     * An identifier for the Amazon fulfillment center that the return items should be sent to.
-     * @type {string}
-     * @memberof ReturnAuthorization
+     * An identifier for the Amazon fulfillment center to which the return items should be sent.
      */
     'fulfillmentCenterId': string;
-    /**
-     *
-     * @type {Address}
-     * @memberof ReturnAuthorization
-     */
     'returnToAddress': Address;
     /**
      * The return merchandise authorization (RMA) that Amazon needs to process the return.
-     * @type {string}
-     * @memberof ReturnAuthorization
      */
     'amazonRmaId': string;
     /**
      * A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping.
-     * @type {string}
-     * @memberof ReturnAuthorization
      */
     'rmaPageURL': string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The condition of the return item when received by an Amazon fulfillment center.
- * @export
- * @enum {string}
  */
 export declare const ReturnItemDisposition: {
     readonly Sellable: "Sellable";