@sp-api-sdk/orders-api-v0 1.18.8 → 2.0.0

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

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Defines the possible status of an order item approval.
+ * @export
+ * @enum {string}
+ */
+export declare const ItemApprovalStatus: {
+    readonly PendingSellingPartnerApproval: "PENDING_SELLING_PARTNER_APPROVAL";
+    readonly ProcessingSellingPartnerApproval: "PROCESSING_SELLING_PARTNER_APPROVAL";
+    readonly PendingAmazonApproval: "PENDING_AMAZON_APPROVAL";
+    readonly Approved: "APPROVED";
+    readonly ApprovedWithChanges: "APPROVED_WITH_CHANGES";
+    readonly Declined: "DECLINED";
+};
+export type ItemApprovalStatus = typeof ItemApprovalStatus[keyof typeof ItemApprovalStatus];

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

@@ -0,0 +1,20 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Defines the approval process types available for order items.
+ * @export
+ * @enum {string}
+ */
+export declare const ItemApprovalType: {
+    readonly LeonardiApproval: "LEONARDI_APPROVAL";
+};
+export type ItemApprovalType = typeof ItemApprovalType[keyof typeof ItemApprovalType];

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

@@ -0,0 +1,72 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemApprovalAction } from './item-approval-action';
+/**
+ * Generic item approval. Check the applicable restrictions at the specific approval type schemas.
+ * @export
+ * @interface ItemApproval
+ */
+export interface ItemApproval {
+    /**
+     * Sequence number of the item approval. Each ItemApproval gets its sequenceId automatically from a monotonic increasing function.
+     * @type {number}
+     * @memberof ItemApproval
+     */
+    'SequenceId': number;
+    /**
+     * Timestamp when the ItemApproval was recorded by Amazon\'s internal order approvals system. In ISO 8601 date time format.
+     * @type {string}
+     * @memberof ItemApproval
+     */
+    'Timestamp': string;
+    /**
+     * High level actors involved in the approval process.
+     * @type {string}
+     * @memberof ItemApproval
+     */
+    'Actor': ItemApprovalActorEnum;
+    /**
+     * Person or system that triggers the approval actions on behalf of the actor.
+     * @type {string}
+     * @memberof ItemApproval
+     */
+    'Approver'?: string;
+    /**
+     *
+     * @type {ItemApprovalAction}
+     * @memberof ItemApproval
+     */
+    'ApprovalAction': ItemApprovalAction;
+    /**
+     * Status of approval action.
+     * @type {string}
+     * @memberof ItemApproval
+     */
+    'ApprovalActionProcessStatus': ItemApprovalApprovalActionProcessStatusEnum;
+    /**
+     * Optional message to communicate optional additional context about the current status of the approval action.
+     * @type {string}
+     * @memberof ItemApproval
+     */
+    'ApprovalActionProcessStatusMessage'?: string;
+}
+export declare const ItemApprovalActorEnum: {
+    readonly SellingPartner: "SELLING_PARTNER";
+    readonly Amazon: "AMAZON";
+};
+export type ItemApprovalActorEnum = typeof ItemApprovalActorEnum[keyof typeof ItemApprovalActorEnum];
+export declare const ItemApprovalApprovalActionProcessStatusEnum: {
+    readonly Processing: "PROCESSING";
+    readonly Success: "SUCCESS";
+    readonly Error: "ERROR";
+};
+export type ItemApprovalApprovalActionProcessStatusEnum = typeof ItemApprovalApprovalActionProcessStatusEnum[keyof typeof ItemApprovalApprovalActionProcessStatusEnum];

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

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Item identifiers used in the context of approvals operations.
+ * @export
+ * @interface ItemIdentifier
+ */
+export interface ItemIdentifier {
+    /**
+     * Defines the type of identifiers allowed to specify a substitution.
+     * @type {string}
+     * @memberof ItemIdentifier
+     */
+    'IdentifierType': ItemIdentifierIdentifierTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ItemIdentifier
+     */
+    'Identifier': string;
+}
+export declare const ItemIdentifierIdentifierTypeEnum: {
+    readonly Asin: "ASIN";
+    readonly SellerSku: "SELLER_SKU";
+    readonly ExternalId: "EXTERNAL_ID";
+};
+export type ItemIdentifierIdentifierTypeEnum = typeof ItemIdentifierIdentifierTypeEnum[keyof typeof ItemIdentifierIdentifierTypeEnum];

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

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrderItemApprovals } from './order-item-approvals';
+/**
+ * The order items list with approvals along with the order ID.
+ * @export
+ * @interface OrderApprovalsResponse
+ */
+export interface OrderApprovalsResponse {
+    /**
+     * When present and not empty, pass this string token in the next request to return the next response page.
+     * @type {string}
+     * @memberof OrderApprovalsResponse
+     */
+    'NextToken'?: string;
+    /**
+     * List of OrderItemApprovals.
+     * @type {Array<OrderItemApprovals>}
+     * @memberof OrderApprovalsResponse
+     */
+    'OrderItemsApprovalsList': Array<OrderItemApprovals>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemApprovalAction } from './item-approval-action';
+/**
+ * Order item apecific approval request.
+ * @export
+ * @interface OrderItemApprovalRequest
+ */
+export interface OrderItemApprovalRequest {
+    /**
+     * The unique identifier of the order item.
+     * @type {string}
+     * @memberof OrderItemApprovalRequest
+     */
+    'OrderItemId': string;
+    /**
+     *
+     * @type {ItemApprovalAction}
+     * @memberof OrderItemApprovalRequest
+     */
+    'ApprovalAction': ItemApprovalAction;
+}

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

@@ -0,0 +1,45 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemApproval } from './item-approval';
+import { ItemApprovalStatus } from './item-approval-status';
+import { ItemApprovalType } from './item-approval-type';
+/**
+ * List of item approvals gathered during the approval process.
+ * @export
+ * @interface OrderItemApprovals
+ */
+export interface OrderItemApprovals {
+    /**
+     * The unique identifier of the order item.
+     * @type {string}
+     * @memberof OrderItemApprovals
+     */
+    'OrderItemId': string;
+    /**
+     *
+     * @type {ItemApprovalType}
+     * @memberof OrderItemApprovals
+     */
+    'ApprovalType': ItemApprovalType;
+    /**
+     *
+     * @type {ItemApprovalStatus}
+     * @memberof OrderItemApprovals
+     */
+    'ApprovalStatus': ItemApprovalStatus;
+    /**
+     *
+     * @type {Array<ItemApproval>}
+     * @memberof OrderItemApprovals
+     */
+    'ItemApprovals': Array<ItemApproval>;
+}

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { BuyerRequestedCancel } from './buyer-requested-cancel';
+import { ItemApprovalContext } from './item-approval-context';
 import { ItemBuyerInfo } from './item-buyer-info';
 import { Money } from './money';
 import { PointsGrantedDetail } from './points-granted-detail';
@@ -225,6 +226,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     'BuyerRequestedCancel'?: BuyerRequestedCancel;
+    /**
+     *
+     * @type {ItemApprovalContext}
+     * @memberof OrderItem
+     */
+    'ItemApprovalContext'?: ItemApprovalContext;
+    /**
+     * A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
+     * @type {Array<string>}
+     * @memberof OrderItem
+     */
+    'SerialNumbers'?: Array<string>;
 }
 export declare const OrderItemDeemedResellerCategoryEnum: {
     readonly Ioss: "IOSS";

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

@@ -16,6 +16,8 @@ import { BuyerTaxInformation } from './buyer-tax-information';
 import { EasyShipShipmentStatus } from './easy-ship-shipment-status';
 import { ElectronicInvoiceStatus } from './electronic-invoice-status';
 import { FulfillmentInstruction } from './fulfillment-instruction';
+import { ItemApprovalStatus } from './item-approval-status';
+import { ItemApprovalType } from './item-approval-type';
 import { MarketplaceTaxInfo } from './marketplace-tax-info';
 import { Money } from './money';
 import { PaymentExecutionDetailItem } from './payment-execution-detail-item';
@@ -307,6 +309,18 @@ export interface Order {
      * @memberof Order
      */
     'ElectronicInvoiceStatus'?: ElectronicInvoiceStatus;
+    /**
+     * Set of approval types which applies to at least one order item in the order.
+     * @type {Array<ItemApprovalType>}
+     * @memberof Order
+     */
+    'ItemApprovalTypes'?: Array<ItemApprovalType>;
+    /**
+     * Subset of all ItemApprovalStatus that are set in at least one of the order items subject to approvals.
+     * @type {Array<ItemApprovalStatus>}
+     * @memberof Order
+     */
+    'ItemApprovalStatus'?: Array<ItemApprovalStatus>;
 }
 export declare const OrderOrderStatusEnum: {
     readonly Pending: "Pending";

package/dist/types/src/api-model/models/update-items-approvals-error-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The error response schema for the updateOrderItemsApprovals operation.
+ * @export
+ * @interface UpdateItemsApprovalsErrorResponse
+ */
+export interface UpdateItemsApprovalsErrorResponse {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateItemsApprovalsErrorResponse
+     */
+    'errors'?: Array<Error>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrderItemApprovalRequest } from './order-item-approval-request';
+/**
+ * The request body for the updateOrderItemsApprovals operation.
+ * @export
+ * @interface UpdateOrderApprovalsRequest
+ */
+export interface UpdateOrderApprovalsRequest {
+    /**
+     * Person or system that triggers the approval actions on behalf of the actor.
+     * @type {string}
+     * @memberof UpdateOrderApprovalsRequest
+     */
+    'Approver'?: string;
+    /**
+     * A list of item approval requests.
+     * @type {Array<OrderItemApprovalRequest>}
+     * @memberof UpdateOrderApprovalsRequest
+     */
+    'OrderItemsApprovalRequests': Array<OrderItemApprovalRequest>;
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/orders-api-v0",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
-  "version": "1.18.8",
+  "version": "2.0.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -26,7 +26,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@sp-api-sdk/common": "^1.9.20",
+    "@sp-api-sdk/common": "^1.9.22",
     "axios": "^0.27.2"
   },
   "repository": {
@@ -51,5 +51,5 @@
   "typedoc": {
     "entryPoint": "./index.ts"
   },
-  "gitHead": "e8ea8ef5b7745f2c4413bd7dd8eefa1b31cee128"
+  "gitHead": "19982f06cbbd770bfc7b9f1bc8a42f59b57baead"
 }