@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 1.7.1

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

@@ -0,0 +1,44 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Container } from './container';
+import { PartyIdentification } from './party-identification';
+/**
+ *
+ * @export
+ * @interface ShippingLabelRequest
+ */
+export interface ShippingLabelRequest {
+    /**
+     * Purchase order number of the order for which to create a shipping label.
+     * @type {string}
+     * @memberof ShippingLabelRequest
+     */
+    purchaseOrderNumber: string;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShippingLabelRequest
+     */
+    sellingParty: PartyIdentification;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShippingLabelRequest
+     */
+    shipFromParty: PartyIdentification;
+    /**
+     * A list of the packages in this shipment.
+     * @type {Array<Container>}
+     * @memberof ShippingLabelRequest
+     */
+    containers?: Array<Container>;
+}

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

@@ -0,0 +1,58 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LabelData } from './label-data';
+import { PartyIdentification } from './party-identification';
+/**
+ *
+ * @export
+ * @interface ShippingLabel
+ */
+export interface ShippingLabel {
+    /**
+     * This field will contain the Purchase Order Number for this order.
+     * @type {string}
+     * @memberof ShippingLabel
+     */
+    purchaseOrderNumber: string;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShippingLabel
+     */
+    sellingParty: PartyIdentification;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShippingLabel
+     */
+    shipFromParty: PartyIdentification;
+    /**
+     * Format of the label.
+     * @type {string}
+     * @memberof ShippingLabel
+     */
+    labelFormat: ShippingLabelLabelFormatEnum;
+    /**
+     * Provides the details of the packages in this shipment.
+     * @type {Array<LabelData>}
+     * @memberof ShippingLabel
+     */
+    labelData: Array<LabelData>;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ShippingLabelLabelFormatEnum {
+    Png = "PNG",
+    Zpl = "ZPL"
+}

package/dist/types/src/api-model/models/status-update-details-shipment-schedule.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface StatusUpdateDetailsShipmentSchedule
+ */
+export interface StatusUpdateDetailsShipmentSchedule {
+    /**
+     * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
+     * @type {string}
+     * @memberof StatusUpdateDetailsShipmentSchedule
+     */
+    estimatedDeliveryDateTime?: string;
+    /**
+     * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
+     * @type {string}
+     * @memberof StatusUpdateDetailsShipmentSchedule
+     */
+    apptWindowStartDateTime?: string;
+    /**
+     * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
+     * @type {string}
+     * @memberof StatusUpdateDetailsShipmentSchedule
+     */
+    apptWindowEndDateTime?: string;
+}

package/dist/types/src/api-model/models/status-update-details.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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 { StatusUpdateDetailsShipmentSchedule } from './status-update-details-shipment-schedule';
+/**
+ * Details for the shipment status update given by the vendor for the specific package.
+ * @export
+ * @interface StatusUpdateDetails
+ */
+export interface StatusUpdateDetails {
+    /**
+     * This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.
+     * @type {string}
+     * @memberof StatusUpdateDetails
+     */
+    trackingNumber: string;
+    /**
+     * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer.
+     * @type {string}
+     * @memberof StatusUpdateDetails
+     */
+    statusCode: string;
+    /**
+     * Provides a reason code for the status of the package that will provide additional information about the transportation status.
+     * @type {string}
+     * @memberof StatusUpdateDetails
+     */
+    reasonCode: string;
+    /**
+     * The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
+     * @type {string}
+     * @memberof StatusUpdateDetails
+     */
+    statusDateTime: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof StatusUpdateDetails
+     */
+    statusLocationAddress: Address;
+    /**
+     *
+     * @type {StatusUpdateDetailsShipmentSchedule}
+     * @memberof StatusUpdateDetails
+     */
+    shipmentSchedule?: StatusUpdateDetailsShipmentSchedule;
+}

package/dist/types/src/api-model/models/submit-shipment-confirmations-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ShipmentConfirmation } from './shipment-confirmation';
+/**
+ *
+ * @export
+ * @interface SubmitShipmentConfirmationsRequest
+ */
+export interface SubmitShipmentConfirmationsRequest {
+    /**
+     *
+     * @type {Array<ShipmentConfirmation>}
+     * @memberof SubmitShipmentConfirmationsRequest
+     */
+    shipmentConfirmations?: Array<ShipmentConfirmation>;
+}

package/dist/types/src/api-model/models/submit-shipment-confirmations-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TransactionReference } from './transaction-reference';
+/**
+ * The response schema for the submitShipmentConfirmations operation.
+ * @export
+ * @interface SubmitShipmentConfirmationsResponse
+ */
+export interface SubmitShipmentConfirmationsResponse {
+    /**
+     *
+     * @type {TransactionReference}
+     * @memberof SubmitShipmentConfirmationsResponse
+     */
+    payload?: TransactionReference;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof SubmitShipmentConfirmationsResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/submit-shipment-status-updates-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ShipmentStatusUpdate } from './shipment-status-update';
+/**
+ *
+ * @export
+ * @interface SubmitShipmentStatusUpdatesRequest
+ */
+export interface SubmitShipmentStatusUpdatesRequest {
+    /**
+     *
+     * @type {Array<ShipmentStatusUpdate>}
+     * @memberof SubmitShipmentStatusUpdatesRequest
+     */
+    shipmentStatusUpdates?: Array<ShipmentStatusUpdate>;
+}

package/dist/types/src/api-model/models/submit-shipment-status-updates-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TransactionReference } from './transaction-reference';
+/**
+ * The response schema for the submitShipmentStatusUpdates operation.
+ * @export
+ * @interface SubmitShipmentStatusUpdatesResponse
+ */
+export interface SubmitShipmentStatusUpdatesResponse {
+    /**
+     *
+     * @type {TransactionReference}
+     * @memberof SubmitShipmentStatusUpdatesResponse
+     */
+    payload?: TransactionReference;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof SubmitShipmentStatusUpdatesResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/submit-shipping-labels-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ShippingLabelRequest } from './shipping-label-request';
+/**
+ *
+ * @export
+ * @interface SubmitShippingLabelsRequest
+ */
+export interface SubmitShippingLabelsRequest {
+    /**
+     *
+     * @type {Array<ShippingLabelRequest>}
+     * @memberof SubmitShippingLabelsRequest
+     */
+    shippingLabelRequests?: Array<ShippingLabelRequest>;
+}

package/dist/types/src/api-model/models/submit-shipping-labels-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TransactionReference } from './transaction-reference';
+/**
+ * The response schema for the submitShippingLabelRequest operation.
+ * @export
+ * @interface SubmitShippingLabelsResponse
+ */
+export interface SubmitShippingLabelsResponse {
+    /**
+     *
+     * @type {TransactionReference}
+     * @memberof SubmitShippingLabelsResponse
+     */
+    payload?: TransactionReference;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof SubmitShippingLabelsResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/tax-registration-details.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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';
+/**
+ * Tax registration details of the entity.
+ * @export
+ * @interface TaxRegistrationDetails
+ */
+export interface TaxRegistrationDetails {
+    /**
+     * Tax registration type for the entity.
+     * @type {string}
+     * @memberof TaxRegistrationDetails
+     */
+    taxRegistrationType?: TaxRegistrationDetailsTaxRegistrationTypeEnum;
+    /**
+     * Tax registration number for the party. For example, VAT ID.
+     * @type {string}
+     * @memberof TaxRegistrationDetails
+     */
+    taxRegistrationNumber: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof TaxRegistrationDetails
+     */
+    taxRegistrationAddress?: Address;
+    /**
+     * Tax registration message that can be used for additional tax related details.
+     * @type {string}
+     * @memberof TaxRegistrationDetails
+     */
+    taxRegistrationMessages?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum TaxRegistrationDetailsTaxRegistrationTypeEnum {
+    Vat = "VAT",
+    Gst = "GST"
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Selling Partner API for Direct Fulfillment Shipping
+ * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface TransactionReference
+ */
+export interface TransactionReference {
+    /**
+     * GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
+     * @type {string}
+     * @memberof TransactionReference
+     */
+    transactionId?: string;
+}