@sp-api-sdk/orders-api-v0 1.9.2 → 1.11.1

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

@@ -0,0 +1,44 @@
+/**
+ * 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 { RegulatedInformation } from './regulated-information';
+import { RegulatedOrderVerificationStatus } from './regulated-order-verification-status';
+/**
+ * The order\'s regulated information along with its verification status.
+ * @export
+ * @interface OrderRegulatedInfo
+ */
+export interface OrderRegulatedInfo {
+    /**
+     * An Amazon-defined order identifier, in 3-7-7 format.
+     * @type {string}
+     * @memberof OrderRegulatedInfo
+     */
+    AmazonOrderId: string;
+    /**
+     *
+     * @type {RegulatedInformation}
+     * @memberof OrderRegulatedInfo
+     */
+    RegulatedInformation: RegulatedInformation;
+    /**
+     * Whether the order requires attaching a dosage information label when shipped.
+     * @type {boolean}
+     * @memberof OrderRegulatedInfo
+     */
+    RequiresDosageLabel: boolean;
+    /**
+     *
+     * @type {RegulatedOrderVerificationStatus}
+     * @memberof OrderRegulatedInfo
+     */
+    RegulatedOrderVerificationStatus: RegulatedOrderVerificationStatus;
+}

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

@@ -221,6 +221,12 @@ export interface Order {
      * @memberof Order
      */
     IsSoldByAB?: boolean;
+    /**
+     * When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.
+     * @type {boolean}
+     * @memberof Order
+     */
+    IsIBA?: boolean;
     /**
      *
      * @type {Address}
@@ -228,7 +234,7 @@ export interface Order {
      */
     DefaultShipFromLocationAddress?: Address;
     /**
-     * The buyer’s invoicing preference.
+     * The buyer\'s invoicing preference. Available only in the TR marketplace.
      * @type {string}
      * @memberof Order
      */
@@ -281,6 +287,12 @@ export interface Order {
      * @memberof Order
      */
     AutomatedShippingSettings?: AutomatedShippingSettings;
+    /**
+     * Whether the order contains regulated items which may require additional approval steps before being fulfilled.
+     * @type {boolean}
+     * @memberof Order
+     */
+    HasRegulatedItems?: boolean;
 }
 /**
     * @export

package/dist/types/src/api-model/models/regulated-information-field.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * A field collected from the regulatory form.
+ * @export
+ * @interface RegulatedInformationField
+ */
+export interface RegulatedInformationField {
+    /**
+     * The unique identifier for the field.
+     * @type {string}
+     * @memberof RegulatedInformationField
+     */
+    FieldId: string;
+    /**
+     * The human-readable name for the field.
+     * @type {string}
+     * @memberof RegulatedInformationField
+     */
+    FieldLabel: string;
+    /**
+     * The type of field the field.
+     * @type {string}
+     * @memberof RegulatedInformationField
+     */
+    FieldType: RegulatedInformationFieldFieldTypeEnum;
+    /**
+     * The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain an URL to download the attachment here.
+     * @type {string}
+     * @memberof RegulatedInformationField
+     */
+    FieldValue: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum RegulatedInformationFieldFieldTypeEnum {
+    Text = "Text",
+    FileAttachment = "FileAttachment"
+}

package/dist/types/src/api-model/models/regulated-information.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.
+ */
+import { RegulatedInformationField } from './regulated-information-field';
+/**
+ * The regulated information collected during purchase and used to verify the order.
+ * @export
+ * @interface RegulatedInformation
+ */
+export interface RegulatedInformation {
+    /**
+     * A list of regulated information fields as collected from the regulatory form.
+     * @type {Array<RegulatedInformationField>}
+     * @memberof RegulatedInformation
+     */
+    Fields: Array<RegulatedInformationField>;
+}

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

@@ -0,0 +1,66 @@
+/**
+ * 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 { RejectionReason } from './rejection-reason';
+/**
+ * The verification status of the order along with associated approval or rejection metadata.
+ * @export
+ * @interface RegulatedOrderVerificationStatus
+ */
+export interface RegulatedOrderVerificationStatus {
+    /**
+     * The verification status of the order.
+     * @type {string}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    Status: RegulatedOrderVerificationStatusStatusEnum;
+    /**
+     * Whether the regulated information provided in the order requires a review by the merchant.
+     * @type {boolean}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    RequiresMerchantAction: boolean;
+    /**
+     * A list of valid rejection reasons that may be used to reject the order\'s regulated information.
+     * @type {Array<RejectionReason>}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    ValidRejectionReasons: Array<RejectionReason>;
+    /**
+     *
+     * @type {RejectionReason}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    RejectionReason?: RejectionReason;
+    /**
+     * The date the order was reviewed. In ISO 8601 date time format.
+     * @type {string}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    ReviewDate?: string;
+    /**
+     * The identifier for the order\'s regulated information reviewer.
+     * @type {string}
+     * @memberof RegulatedOrderVerificationStatus
+     */
+    ExternalReviewerId?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum RegulatedOrderVerificationStatusStatusEnum {
+    Pending = "Pending",
+    Approved = "Approved",
+    Rejected = "Rejected",
+    Expired = "Expired",
+    Cancelled = "Cancelled"
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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 reason for rejecting the order\'s regulated information. Not present if the order isn\'t rejected.
+ * @export
+ * @interface RejectionReason
+ */
+export interface RejectionReason {
+    /**
+     * The unique identifier for the rejection reason.
+     * @type {string}
+     * @memberof RejectionReason
+     */
+    RejectionReasonId: string;
+    /**
+     * The human-readable description of this rejection reason.
+     * @type {string}
+     * @memberof RejectionReason
+     */
+    RejectionReasonDescription: string;
+}

package/dist/types/src/api-model/models/update-verification-status-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 UpdateVerificationStatus operation.
+ * @export
+ * @interface UpdateVerificationStatusErrorResponse
+ */
+export interface UpdateVerificationStatusErrorResponse {
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof UpdateVerificationStatusErrorResponse
+     */
+    errors?: Array<Error>;
+}

package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 updated values of the VerificationStatus field.
+ * @export
+ * @interface UpdateVerificationStatusRequestBody
+ */
+export interface UpdateVerificationStatusRequestBody {
+    /**
+     * The new verification status of the order.
+     * @type {string}
+     * @memberof UpdateVerificationStatusRequestBody
+     */
+    status: UpdateVerificationStatusRequestBodyStatusEnum;
+    /**
+     * The identifier for the order\'s regulated information reviewer.
+     * @type {string}
+     * @memberof UpdateVerificationStatusRequestBody
+     */
+    externalReviewerId: string;
+    /**
+     * The unique identifier for the rejection reason used for rejecting the order\'s regulated information. Only required if the new status is rejected.
+     * @type {string}
+     * @memberof UpdateVerificationStatusRequestBody
+     */
+    rejectionReasonId?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum UpdateVerificationStatusRequestBodyStatusEnum {
+    Approved = "Approved",
+    Rejected = "Rejected"
+}

package/dist/types/src/api-model/models/update-verification-status-request.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.
+ */
+import { UpdateVerificationStatusRequestBody } from './update-verification-status-request-body';
+/**
+ * Request to update the verification status of an order containing regulated products.
+ * @export
+ * @interface UpdateVerificationStatusRequest
+ */
+export interface UpdateVerificationStatusRequest {
+    /**
+     *
+     * @type {UpdateVerificationStatusRequestBody}
+     * @memberof UpdateVerificationStatusRequest
+     */
+    regulatedOrderVerificationStatus: UpdateVerificationStatusRequestBody;
+}

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.9.2",
+  "version": "1.11.1",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -26,9 +26,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.8",
-    "@sp-api-sdk/common": "^1.7.10",
-    "axios": "^0.26.0"
+    "@sp-api-sdk/auth": "^1.9.11",
+    "@sp-api-sdk/common": "^1.7.13",
+    "axios": "^0.26.1"
   },
   "repository": {
     "type": "git",
@@ -49,5 +49,5 @@
     "sp sdk",
     "orders api"
   ],
-  "gitHead": "3f4ecdeef2ce06ff28612448d263cc8d08eb69f6"
+  "gitHead": "61adb3dd4480de30ba48c20a1da60cebf9d4f0ac"
 }