@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.0.1

package/dist/types/src/api-model/models/get-delivery-challan-document-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DocumentDownload } from './document-download';
+/**
+ * The `getDeliveryChallanDocumentResponse` response.
+ * @export
+ * @interface GetDeliveryChallanDocumentResponse
+ */
+export interface GetDeliveryChallanDocumentResponse {
+    /**
+     *
+     * @type {DocumentDownload}
+     * @memberof GetDeliveryChallanDocumentResponse
+     */
+    'documentDownload': DocumentDownload;
+}

package/dist/types/src/api-model/models/get-self-ship-appointment-slots-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { SelfShipAppointmentSlotsAvailability } from './self-ship-appointment-slots-availability';
+/**
+ * The `getSelfShipAppointmentSlots` response.
+ * @export
+ * @interface GetSelfShipAppointmentSlotsResponse
+ */
+export interface GetSelfShipAppointmentSlotsResponse {
+    /**
+     *
+     * @type {Pagination}
+     * @memberof GetSelfShipAppointmentSlotsResponse
+     */
+    'pagination'?: Pagination;
+    /**
+     *
+     * @type {SelfShipAppointmentSlotsAvailability}
+     * @memberof GetSelfShipAppointmentSlotsResponse
+     */
+    'selfShipAppointmentSlotsAvailability': SelfShipAppointmentSlotsAvailability;
+}

package/dist/types/src/api-model/models/inbound-operation-status.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OperationProblem } from './operation-problem';
+import { OperationStatus } from './operation-status';
+/**
+ * The `getInboundOperationStatus` response.
+ * @export
+ * @interface InboundOperationStatus
+ */
+export interface InboundOperationStatus {
+    /**
+     * The name of the operation that was executed in the asynchronous API call.
+     * @type {string}
+     * @memberof InboundOperationStatus
+     */
+    'operation': string;
+    /**
+     * The operation Id returned by the asynchronous API call.
+     * @type {string}
+     * @memberof InboundOperationStatus
+     */
+    'operationId': string;
+    /**
+     * The problems in the processing of the asynchronous operation.
+     * @type {Array<OperationProblem>}
+     * @memberof InboundOperationStatus
+     */
+    'operationProblems': Array<OperationProblem>;
+    /**
+     *
+     * @type {OperationStatus}
+     * @memberof InboundOperationStatus
+     */
+    'operationStatus': OperationStatus;
+}

package/dist/types/src/api-model/models/inbound-plan-summary.d.ts

@@ -0,0 +1,68 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Address } from './address';
+import { ContactInformation } from './contact-information';
+/**
+ * A light-weight inbound plan.
+ * @export
+ * @interface InboundPlanSummary
+ */
+export interface InboundPlanSummary {
+    /**
+     *
+     * @type {ContactInformation}
+     * @memberof InboundPlanSummary
+     */
+    'contactInformation': ContactInformation;
+    /**
+     * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof InboundPlanSummary
+     */
+    'createdAt': string;
+    /**
+     * Identifier to an inbound plan.
+     * @type {string}
+     * @memberof InboundPlanSummary
+     */
+    'inboundPlanId': string;
+    /**
+     * ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof InboundPlanSummary
+     */
+    'lastUpdatedAt': string;
+    /**
+     * Marketplace IDs.
+     * @type {Array<string>}
+     * @memberof InboundPlanSummary
+     */
+    'marketplaceIds': Array<string>;
+    /**
+     * Human-readable name of the inbound plan.
+     * @type {string}
+     * @memberof InboundPlanSummary
+     */
+    'name': string;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundPlanSummary
+     */
+    'sourceAddress': Address;
+    /**
+     * Current status of the inbound plan. Can be \'ACTIVE\', \'VOIDED\', or \'SHIPPED\'.
+     * @type {string}
+     * @memberof InboundPlanSummary
+     */
+    'status': string;
+}

package/dist/types/src/api-model/models/inbound-plan.d.ts

@@ -0,0 +1,89 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Address } from './address';
+import { ContactInformation } from './contact-information';
+import { PackingOptionSummary } from './packing-option-summary';
+import { PlacementOptionSummary } from './placement-option-summary';
+import { ShipmentSummary } from './shipment-summary';
+/**
+ * Inbound plan containing details of the inbound workflow.
+ * @export
+ * @interface InboundPlan
+ */
+export interface InboundPlan {
+    /**
+     *
+     * @type {ContactInformation}
+     * @memberof InboundPlan
+     */
+    'contactInformation': ContactInformation;
+    /**
+     * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof InboundPlan
+     */
+    'createdAt': string;
+    /**
+     * Identifier to an inbound plan.
+     * @type {string}
+     * @memberof InboundPlan
+     */
+    'inboundPlanId': string;
+    /**
+     * The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
+     * @type {string}
+     * @memberof InboundPlan
+     */
+    'lastUpdatedAt': string;
+    /**
+     * Marketplace IDs.
+     * @type {Array<string>}
+     * @memberof InboundPlan
+     */
+    'marketplaceIds': Array<string>;
+    /**
+     * The human-readable name of the inbound plan.
+     * @type {string}
+     * @memberof InboundPlan
+     */
+    'name': string;
+    /**
+     * Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details.
+     * @type {Array<PackingOptionSummary>}
+     * @memberof InboundPlan
+     */
+    'packingOptions'?: Array<PackingOptionSummary>;
+    /**
+     * Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details.
+     * @type {Array<PlacementOptionSummary>}
+     * @memberof InboundPlan
+     */
+    'placementOptions'?: Array<PlacementOptionSummary>;
+    /**
+     * Shipment IDs for the inbound plan. This property will be populated when it has been generated via the corresponding endpoint. If there is a chosen placement option, only shipments for that option will be returned. If there are confirmed shipments, only those shipments will be returned. Query the shipment for more details.
+     * @type {Array<ShipmentSummary>}
+     * @memberof InboundPlan
+     */
+    'shipments'?: Array<ShipmentSummary>;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundPlan
+     */
+    'sourceAddress': Address;
+    /**
+     * Current status of the inbound plan. Can be `ACTIVE`, `VOIDED`, or `SHIPPED`.
+     * @type {string}
+     * @memberof InboundPlan
+     */
+    'status': string;
+}

package/dist/types/src/api-model/models/incentive.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Currency } from './currency';
+/**
+ * Contains details about cost related modifications to the placement cost.
+ * @export
+ * @interface Incentive
+ */
+export interface Incentive {
+    /**
+     * Description of the incentive.
+     * @type {string}
+     * @memberof Incentive
+     */
+    'description': string;
+    /**
+     * Target of the incentive. Can be \'Placement Services\' or \'Fulfillment Fee Discount\'.
+     * @type {string}
+     * @memberof Incentive
+     */
+    'target': string;
+    /**
+     * Type of incentive. Can be `FEE` or `DISCOUNT`.
+     * @type {string}
+     * @memberof Incentive
+     */
+    'type': string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Incentive
+     */
+    'value': Currency;
+}

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

@@ -0,0 +1,103 @@
+export * from './address';
+export * from './appointment-slot';
+export * from './appointment-slot-time';
+export * from './box';
+export * from './box-content';
+export * from './box-content-information-source';
+export * from './box-input';
+export * from './cancel-inbound-plan-response';
+export * from './cancel-self-ship-appointment-request';
+export * from './cancel-self-ship-appointment-response';
+export * from './carrier';
+export * from './compliance-detail';
+export * from './confirm-packing-option-response';
+export * from './confirm-placement-option-response';
+export * from './confirm-transportation-options-request';
+export * from './confirm-transportation-options-response';
+export * from './contact-information';
+export * from './create-inbound-plan-request';
+export * from './create-inbound-plan-response';
+export * from './currency';
+export * from './custom-placement-input';
+export * from './dates';
+export * from './dimensions';
+export * from './document-download';
+export * from './error-list';
+export * from './generate-packing-options-response';
+export * from './generate-placement-options-request';
+export * from './generate-placement-options-response';
+export * from './generate-self-ship-appointment-slots-request';
+export * from './generate-self-ship-appointment-slots-response';
+export * from './generate-transportation-options-request';
+export * from './generate-transportation-options-response';
+export * from './get-delivery-challan-document-response';
+export * from './get-self-ship-appointment-slots-response';
+export * from './inbound-operation-status';
+export * from './inbound-plan';
+export * from './inbound-plan-summary';
+export * from './incentive';
+export * from './item';
+export * from './item-input';
+export * from './label-owner';
+export * from './list-inbound-plan-boxes-response';
+export * from './list-inbound-plan-items-response';
+export * from './list-inbound-plan-pallets-response';
+export * from './list-inbound-plans-response';
+export * from './list-item-compliance-details-response';
+export * from './list-packing-group-items-response';
+export * from './list-packing-options-response';
+export * from './list-placement-options-response';
+export * from './list-transportation-options-response';
+export * from './ltl-tracking-detail';
+export * from './ltl-tracking-detail-input';
+export * from './model-error';
+export * from './operation-problem';
+export * from './operation-status';
+export * from './package-grouping-input';
+export * from './packing-option';
+export * from './packing-option-summary';
+export * from './pagination';
+export * from './pallet';
+export * from './pallet-information';
+export * from './pallet-input';
+export * from './placement-option';
+export * from './placement-option-summary';
+export * from './prep-instruction';
+export * from './prep-owner';
+export * from './quote';
+export * from './reason-comment';
+export * from './region';
+export * from './schedule-self-ship-appointment-request';
+export * from './schedule-self-ship-appointment-response';
+export * from './self-ship-appointment-details';
+export * from './self-ship-appointment-slots-availability';
+export * from './set-packing-information-request';
+export * from './set-packing-information-response';
+export * from './shipment';
+export * from './shipment-destination';
+export * from './shipment-source';
+export * from './shipment-summary';
+export * from './shipment-transportation-configuration';
+export * from './shipping-configuration';
+export * from './spd-tracking-detail';
+export * from './spd-tracking-detail-input';
+export * from './spd-tracking-item';
+export * from './spd-tracking-item-input';
+export * from './stackability';
+export * from './tax-details';
+export * from './tax-rate';
+export * from './tracking-details';
+export * from './tracking-details-input';
+export * from './transportation-option';
+export * from './transportation-selection';
+export * from './unit-of-measurement';
+export * from './unit-of-weight';
+export * from './update-item-compliance-details-request';
+export * from './update-item-compliance-details-response';
+export * from './update-shipment-delivery-window-request';
+export * from './update-shipment-delivery-window-response';
+export * from './update-shipment-tracking-details-request';
+export * from './update-shipment-tracking-details-response';
+export * from './weight';
+export * from './window';
+export * from './window-input';

package/dist/types/src/api-model/models/item-input.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LabelOwner } from './label-owner';
+import { PrepOwner } from './prep-owner';
+/**
+ * Defines an item\'s input parameters.
+ * @export
+ * @interface ItemInput
+ */
+export interface ItemInput {
+    /**
+     * The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box.
+     * @type {string}
+     * @memberof ItemInput
+     */
+    'expiration'?: string;
+    /**
+     *
+     * @type {LabelOwner}
+     * @memberof ItemInput
+     */
+    'labelOwner': LabelOwner;
+    /**
+     * The manufacturing lot code.
+     * @type {string}
+     * @memberof ItemInput
+     */
+    'manufacturingLotCode'?: string;
+    /**
+     * The merchant SKU.
+     * @type {string}
+     * @memberof ItemInput
+     */
+    'msku': string;
+    /**
+     *
+     * @type {PrepOwner}
+     * @memberof ItemInput
+     */
+    'prepOwner': PrepOwner;
+    /**
+     * The number of units of the specified MSKU that will be shipped.
+     * @type {number}
+     * @memberof ItemInput
+     */
+    'quantity': number;
+}

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

@@ -0,0 +1,67 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PrepInstruction } from './prep-instruction';
+/**
+ * Information associated with a single SKU in the seller\'s catalog.
+ * @export
+ * @interface Item
+ */
+export interface Item {
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     * @type {string}
+     * @memberof Item
+     */
+    'asin': string;
+    /**
+     * The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box.
+     * @type {string}
+     * @memberof Item
+     */
+    'expiration'?: string;
+    /**
+     * A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
+     * @type {string}
+     * @memberof Item
+     */
+    'fnsku': string;
+    /**
+     * Specifies who will label the items. Options include `AMAZON` and `SELLER`.
+     * @type {string}
+     * @memberof Item
+     */
+    'labelOwner': string;
+    /**
+     * The manufacturing lot code.
+     * @type {string}
+     * @memberof Item
+     */
+    'manufacturingLotCode'?: string;
+    /**
+     * The merchant defined SKU ID.
+     * @type {string}
+     * @memberof Item
+     */
+    'msku': string;
+    /**
+     * Special preparations that are required for an item.
+     * @type {Array<PrepInstruction>}
+     * @memberof Item
+     */
+    'prepInstructions': Array<PrepInstruction>;
+    /**
+     * The number of the specified MSKU.
+     * @type {number}
+     * @memberof Item
+     */
+    'quantity': number;
+}

package/dist/types/src/api-model/models/label-owner.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Specifies who will label the items. Options include `AMAZON` and `SELLER`.
+ * @export
+ * @enum {string}
+ */
+export declare const LabelOwner: {
+    readonly Amazon: "AMAZON";
+    readonly Seller: "SELLER";
+};
+export type LabelOwner = typeof LabelOwner[keyof typeof LabelOwner];

package/dist/types/src/api-model/models/list-inbound-plan-boxes-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Box } from './box';
+import { Pagination } from './pagination';
+/**
+ * `listInboundPlanBoxes` response.
+ * @export
+ * @interface ListInboundPlanBoxesResponse
+ */
+export interface ListInboundPlanBoxesResponse {
+    /**
+     * A list of boxes in an inbound plan.
+     * @type {Array<Box>}
+     * @memberof ListInboundPlanBoxesResponse
+     */
+    'boxes': Array<Box>;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ListInboundPlanBoxesResponse
+     */
+    'pagination'?: Pagination;
+}

package/dist/types/src/api-model/models/list-inbound-plan-items-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Item } from './item';
+import { Pagination } from './pagination';
+/**
+ * `listInboundPlanItems` response.
+ * @export
+ * @interface ListInboundPlanItemsResponse
+ */
+export interface ListInboundPlanItemsResponse {
+    /**
+     * The items in an inbound plan.
+     * @type {Array<Item>}
+     * @memberof ListInboundPlanItemsResponse
+     */
+    'items': Array<Item>;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ListInboundPlanItemsResponse
+     */
+    'pagination'?: Pagination;
+}

package/dist/types/src/api-model/models/list-inbound-plan-pallets-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { Pallet } from './pallet';
+/**
+ * `listInboundPlanPallets` response.
+ * @export
+ * @interface ListInboundPlanPalletsResponse
+ */
+export interface ListInboundPlanPalletsResponse {
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ListInboundPlanPalletsResponse
+     */
+    'pagination'?: Pagination;
+    /**
+     * The pallets in an inbound plan.
+     * @type {Array<Pallet>}
+     * @memberof ListInboundPlanPalletsResponse
+     */
+    'pallets': Array<Pallet>;
+}