@sp-api-sdk/vendor-shipments-api-v1 1.6.15

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

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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';
+/**
+ * The request schema for the SubmitShipmentConfirmations operation.
+ * @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 Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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/tax-registration-details.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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.
+ */
+/**
+ * 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 entity. For example, VAT ID.
+     * @type {string}
+     * @memberof TaxRegistrationDetails
+     */
+    taxRegistrationNumber: 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 Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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 assigned by Amazon 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;
+}

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

@@ -0,0 +1,51 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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 TransportationDetails
+ */
+export interface TransportationDetails {
+    /**
+     * Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). This field is mandatory for US, CA, MX shipment confirmations.
+     * @type {string}
+     * @memberof TransportationDetails
+     */
+    carrierScac?: string;
+    /**
+     * The field also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for UA, CA, MX shipment confirmations.
+     * @type {string}
+     * @memberof TransportationDetails
+     */
+    carrierShipmentReferenceNumber?: string;
+    /**
+     * The mode of transportation for this shipment.
+     * @type {string}
+     * @memberof TransportationDetails
+     */
+    transportationMode?: TransportationDetailsTransportationModeEnum;
+    /**
+     * Bill Of Lading (BOL) number is the unique number assigned by the vendor. The BOL present in the Shipment Confirmation message ideally matches the paper BOL provided with the shipment, but that is no must. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field.
+     * @type {string}
+     * @memberof TransportationDetails
+     */
+    billOfLadingNumber?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum TransportationDetailsTransportationModeEnum {
+    Road = "Road",
+    Air = "Air",
+    Ocean = "Ocean"
+}

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

@@ -0,0 +1,40 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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.
+ */
+/**
+ * The volume of the container.
+ * @export
+ * @interface Volume
+ */
+export interface Volume {
+    /**
+     * The unit of measurement.
+     * @type {string}
+     * @memberof Volume
+     */
+    unitOfMeasure: VolumeUnitOfMeasureEnum;
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
+     * @type {string}
+     * @memberof Volume
+     */
+    value: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum VolumeUnitOfMeasureEnum {
+    CuFt = "CuFt",
+    CuIn = "CuIn",
+    CuM = "CuM",
+    CuY = "CuY"
+}

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

@@ -0,0 +1,40 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * 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.
+ */
+/**
+ * The weight.
+ * @export
+ * @interface Weight
+ */
+export interface Weight {
+    /**
+     * The unit of measurement.
+     * @type {string}
+     * @memberof Weight
+     */
+    unitOfMeasure: WeightUnitOfMeasureEnum;
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
+     * @type {string}
+     * @memberof Weight
+     */
+    value: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum WeightUnitOfMeasureEnum {
+    G = "G",
+    Kg = "Kg",
+    Oz = "Oz",
+    Lb = "Lb"
+}

package/dist/types/src/client.d.ts

@@ -0,0 +1,13 @@
+import { onRetry } from '@sp-api-sdk/common';
+import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import { VendorShippingApi } from './api-model';
+export declare const RATE_LIMITS: RateLimit[];
+export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
+    rateLimiting?: {
+        retry: boolean;
+        onRetry?: onRetry;
+    };
+}
+export declare class VendorShipmentsApiClient extends VendorShippingApi {
+    constructor(parameters: ClientParameters);
+}

package/dist/types/src/error.d.ts

@@ -0,0 +1,3 @@
+export declare class VendorShipmentsApiError extends Error {
+    constructor(message: string);
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@sp-api-sdk/vendor-shipments-api-v1",
+  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
+  "description": "The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.",
+  "version": "1.6.15",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build": "yarn build:cjs && yarn build:es",
+    "clean": "rimraf dist",
+    "lint": "xo --cwd=../../ $PWD",
+    "test": "NODE_ENV='test' yarn jest"
+  },
+  "dependencies": {
+    "@sp-api-sdk/auth": "^1.9.1",
+    "@sp-api-sdk/common": "^1.7.2",
+    "axios": "^0.21.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/vendor-shipments-api-v1"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/vendor-shipments-api-v1",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "vendor shipments api"
+  ],
+  "gitHead": "dc4286920dc77e99d6ad71f71bcb78ae22b9ab06"
+}