@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 2.1.1 → 2.2.0

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

@@ -0,0 +1,63 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { AcknowledgementStatus } from './acknowledgement-status';
+import { OrderItemAcknowledgement } from './order-item-acknowledgement';
+import { PartyIdentification } from './party-identification';
+/**
+ * Details of an individual order being acknowledged.
+ * @export
+ * @interface OrderAcknowledgementItem
+ */
+export interface OrderAcknowledgementItem {
+    /**
+     * The purchase order number for this order. Formatting Notes: alpha-numeric code.
+     * @type {string}
+     * @memberof OrderAcknowledgementItem
+     */
+    'purchaseOrderNumber': string;
+    /**
+     * The vendor\'s order number for this order.
+     * @type {string}
+     * @memberof OrderAcknowledgementItem
+     */
+    'vendorOrderNumber': string;
+    /**
+     * The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00.
+     * @type {string}
+     * @memberof OrderAcknowledgementItem
+     */
+    'acknowledgementDate': string;
+    /**
+     *
+     * @type {AcknowledgementStatus}
+     * @memberof OrderAcknowledgementItem
+     */
+    'acknowledgementStatus': AcknowledgementStatus;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof OrderAcknowledgementItem
+     */
+    'sellingParty': PartyIdentification;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof OrderAcknowledgementItem
+     */
+    'shipFromParty': PartyIdentification;
+    /**
+     * Item details including acknowledged quantity.
+     * @type {Array<OrderItemAcknowledgement>}
+     * @memberof OrderAcknowledgementItem
+     */
+    'itemAcknowledgements': Array<OrderItemAcknowledgement>;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { TaxDetails } from './tax-details';
+/**
+ *
+ * @export
+ * @interface OrderDetailsTaxTotal
+ */
+export interface OrderDetailsTaxTotal {
+    /**
+     * A list of tax line items.
+     * @type {Array<TaxDetails>}
+     * @memberof OrderDetailsTaxTotal
+     */
+    'taxLineItem'?: Array<TaxDetails>;
+}

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

@@ -0,0 +1,90 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { OrderDetailsTaxTotal } from './order-details-tax-total';
+import { OrderItem } from './order-item';
+import { PartyIdentification } from './party-identification';
+import { ShipmentDetails } from './shipment-details';
+/**
+ * Details of an order.
+ * @export
+ * @interface OrderDetails
+ */
+export interface OrderDetails {
+    /**
+     * The customer order number.
+     * @type {string}
+     * @memberof OrderDetails
+     */
+    'customerOrderNumber': string;
+    /**
+     * The date the order was placed. This field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed.
+     * @type {string}
+     * @memberof OrderDetails
+     */
+    'orderDate': string;
+    /**
+     * Current status of the order.
+     * @type {string}
+     * @memberof OrderDetails
+     */
+    'orderStatus'?: OrderDetailsOrderStatusEnum;
+    /**
+     *
+     * @type {ShipmentDetails}
+     * @memberof OrderDetails
+     */
+    'shipmentDetails': ShipmentDetails;
+    /**
+     *
+     * @type {OrderDetailsTaxTotal}
+     * @memberof OrderDetails
+     */
+    'taxTotal'?: OrderDetailsTaxTotal;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof OrderDetails
+     */
+    'sellingParty': PartyIdentification;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof OrderDetails
+     */
+    'shipFromParty': PartyIdentification;
+    /**
+     *
+     * @type {Address}
+     * @memberof OrderDetails
+     */
+    'shipToParty': Address;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof OrderDetails
+     */
+    'billToParty': PartyIdentification;
+    /**
+     * A list of items in this purchase order.
+     * @type {Array<OrderItem>}
+     * @memberof OrderDetails
+     */
+    'items': Array<OrderItem>;
+}
+export declare const OrderDetailsOrderStatusEnum: {
+    readonly New: "NEW";
+    readonly Shipped: "SHIPPED";
+    readonly Accepted: "ACCEPTED";
+    readonly Cancelled: "CANCELLED";
+};
+export type OrderDetailsOrderStatusEnum = typeof OrderDetailsOrderStatusEnum[keyof typeof OrderDetailsOrderStatusEnum];

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

@@ -0,0 +1,43 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { ItemQuantity } from './item-quantity';
+/**
+ *
+ * @export
+ * @interface OrderItemAcknowledgement
+ */
+export interface OrderItemAcknowledgement {
+    /**
+     * Line item sequence number for the item.
+     * @type {string}
+     * @memberof OrderItemAcknowledgement
+     */
+    'itemSequenceNumber': string;
+    /**
+     * Buyer\'s standard identification number (ASIN) of an item.
+     * @type {string}
+     * @memberof OrderItemAcknowledgement
+     */
+    'buyerProductIdentifier'?: string;
+    /**
+     * The vendor selected product identification of the item. Should be the same as was provided in the purchase order.
+     * @type {string}
+     * @memberof OrderItemAcknowledgement
+     */
+    'vendorProductIdentifier'?: string;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof OrderItemAcknowledgement
+     */
+    'acknowledgedQuantity': ItemQuantity;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { TaxDetails } from './tax-details';
+/**
+ * Total tax details for the line item.
+ * @export
+ * @interface OrderItemTaxDetails
+ */
+export interface OrderItemTaxDetails {
+    /**
+     * A list of tax line items.
+     * @type {Array<TaxDetails>}
+     * @memberof OrderItemTaxDetails
+     */
+    'taxLineItem'?: Array<TaxDetails>;
+}

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

@@ -0,0 +1,83 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { GiftDetails } from './gift-details';
+import { ItemQuantity } from './item-quantity';
+import { Money } from './money';
+import { OrderItemTaxDetails } from './order-item-tax-details';
+import { ScheduledDeliveryShipment } from './scheduled-delivery-shipment';
+/**
+ *
+ * @export
+ * @interface OrderItem
+ */
+export interface OrderItem {
+    /**
+     * Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'itemSequenceNumber': string;
+    /**
+     * Buyer\'s standard identification number (ASIN) of an item.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'buyerProductIdentifier'?: string;
+    /**
+     * The vendor selected product identification of the item.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'vendorProductIdentifier'?: string;
+    /**
+     * Title for the item.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'title'?: string;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof OrderItem
+     */
+    'orderedQuantity': ItemQuantity;
+    /**
+     *
+     * @type {ScheduledDeliveryShipment}
+     * @memberof OrderItem
+     */
+    'scheduledDeliveryShipment'?: ScheduledDeliveryShipment;
+    /**
+     *
+     * @type {GiftDetails}
+     * @memberof OrderItem
+     */
+    'giftDetails'?: GiftDetails;
+    /**
+     *
+     * @type {Money}
+     * @memberof OrderItem
+     */
+    'netPrice': Money;
+    /**
+     *
+     * @type {OrderItemTaxDetails}
+     * @memberof OrderItem
+     */
+    'taxDetails'?: OrderItemTaxDetails;
+    /**
+     *
+     * @type {Money}
+     * @memberof OrderItem
+     */
+    'totalPrice'?: Money;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { Order } from './order';
+import { Pagination } from './pagination';
+/**
+ *
+ * @export
+ * @interface OrderList
+ */
+export interface OrderList {
+    /**
+     *
+     * @type {Pagination}
+     * @memberof OrderList
+     */
+    'pagination'?: Pagination;
+    /**
+     *
+     * @type {Array<Order>}
+     * @memberof OrderList
+     */
+    'orders'?: Array<Order>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { OrderDetails } from './order-details';
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     * The purchase order number for this order. Formatting Notes: alpha-numeric code.
+     * @type {string}
+     * @memberof Order
+     */
+    'purchaseOrderNumber': string;
+    /**
+     *
+     * @type {OrderDetails}
+     * @memberof Order
+     */
+    'orderDetails'?: OrderDetails;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 Pagination
+ */
+export interface Pagination {
+    /**
+     * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.
+     * @type {string}
+     * @memberof Pagination
+     */
+    'nextToken'?: string;
+}

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

@@ -1,6 +1,6 @@
 /**
- * Selling Partner API for Direct Fulfillment Inventory Updates
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
  *
  * The version of the OpenAPI document: v1
  *
@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { Address } from './address';
+import { TaxRegistrationDetails } from './tax-registration-details';
 /**
  *
  * @export
@@ -16,9 +18,21 @@
  */
 export interface PartyIdentification {
     /**
-     * Assigned identification for the party.
+     * Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
      * @type {string}
      * @memberof PartyIdentification
      */
     'partyId': string;
+    /**
+     *
+     * @type {Address}
+     * @memberof PartyIdentification
+     */
+    'address'?: Address;
+    /**
+     *
+     * @type {TaxRegistrationDetails}
+     * @memberof PartyIdentification
+     */
+    'taxInfo'?: TaxRegistrationDetails;
 }

package/dist/types/src/api-model/models/scheduled-delivery-shipment.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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.
+ */
+/**
+ * Dates for the scheduled delivery shipments.
+ * @export
+ * @interface ScheduledDeliveryShipment
+ */
+export interface ScheduledDeliveryShipment {
+    /**
+     * Scheduled delivery service type.
+     * @type {string}
+     * @memberof ScheduledDeliveryShipment
+     */
+    'scheduledDeliveryServiceType'?: string;
+    /**
+     * Earliest nominated delivery date for the scheduled delivery.
+     * @type {string}
+     * @memberof ScheduledDeliveryShipment
+     */
+    'earliestNominatedDeliveryDate'?: string;
+    /**
+     * Latest nominated delivery date for the scheduled delivery.
+     * @type {string}
+     * @memberof ScheduledDeliveryShipment
+     */
+    'latestNominatedDeliveryDate'?: string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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.
+ */
+/**
+ * Shipment dates.
+ * @export
+ * @interface ShipmentDates
+ */
+export interface ShipmentDates {
+    /**
+     * Time by which the vendor is required to ship the order.
+     * @type {string}
+     * @memberof ShipmentDates
+     */
+    'requiredShipDate': string;
+    /**
+     * Delivery date promised to the Amazon customer.
+     * @type {string}
+     * @memberof ShipmentDates
+     */
+    'promisedDeliveryDate'?: string;
+}

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

@@ -0,0 +1,61 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { ShipmentDates } from './shipment-dates';
+/**
+ * Shipment details required for the shipment.
+ * @export
+ * @interface ShipmentDetails
+ */
+export interface ShipmentDetails {
+    /**
+     * When true, this is a priority shipment.
+     * @type {boolean}
+     * @memberof ShipmentDetails
+     */
+    'isPriorityShipment': boolean;
+    /**
+     * When true, this order is part of a scheduled delivery program.
+     * @type {boolean}
+     * @memberof ShipmentDetails
+     */
+    'isScheduledDeliveryShipment'?: boolean;
+    /**
+     * When true, a packing slip is required to be sent to the customer.
+     * @type {boolean}
+     * @memberof ShipmentDetails
+     */
+    'isPslipRequired': boolean;
+    /**
+     * When true, the order contain a gift. Include the gift message and gift wrap information.
+     * @type {boolean}
+     * @memberof ShipmentDetails
+     */
+    'isGift'?: boolean;
+    /**
+     * Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the \'Help\' section on Vendor Central for \'ship methods\'.
+     * @type {string}
+     * @memberof ShipmentDetails
+     */
+    'shipMethod': string;
+    /**
+     *
+     * @type {ShipmentDates}
+     * @memberof ShipmentDetails
+     */
+    'shipmentDates': ShipmentDates;
+    /**
+     * Message to customer for order status.
+     * @type {string}
+     * @memberof ShipmentDetails
+     */
+    'messageToCustomer': string;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { OrderAcknowledgementItem } from './order-acknowledgement-item';
+/**
+ * The request schema for the submitAcknowledgement operation.
+ * @export
+ * @interface SubmitAcknowledgementRequest
+ */
+export interface SubmitAcknowledgementRequest {
+    /**
+     * A list of one or more purchase orders.
+     * @type {Array<OrderAcknowledgementItem>}
+     * @memberof SubmitAcknowledgementRequest
+     */
+    'orderAcknowledgements'?: Array<OrderAcknowledgementItem>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Direct Fulfillment Orders
+ * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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 { TransactionId } from './transaction-id';
+/**
+ * The response schema for the submitAcknowledgement operation.
+ * @export
+ * @interface SubmitAcknowledgementResponse
+ */
+export interface SubmitAcknowledgementResponse {
+    /**
+     *
+     * @type {TransactionId}
+     * @memberof SubmitAcknowledgementResponse
+     */
+    'payload'?: TransactionId;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof SubmitAcknowledgementResponse
+     */
+    'errors'?: Array<Error>;
+}