@sp-api-sdk/finances-api-v0 1.7.0

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

@@ -0,0 +1,37 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { ChargeComponent } from './charge-component';
+/**
+ * An item from a SAFE-T claim reimbursement.
+ * @export
+ * @interface SAFETReimbursementItem
+ */
+export interface SAFETReimbursementItem {
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof SAFETReimbursementItem
+     */
+    itemChargeList?: Array<ChargeComponent>;
+    /**
+     * The description of the item as shown on the product detail page on the retail website.
+     * @type {string}
+     * @memberof SAFETReimbursementItem
+     */
+    productDescription?: string;
+    /**
+     * The number of units of the item being reimbursed.
+     * @type {string}
+     * @memberof SAFETReimbursementItem
+     */
+    quantity?: string;
+}

package/dist/types/src/api-model/models/seller-deal-payment-event.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { Currency } from './currency';
+/**
+ * An event linked to the payment of a fee related to the specified deal.
+ * @export
+ * @interface SellerDealPaymentEvent
+ */
+export interface SellerDealPaymentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof SellerDealPaymentEvent
+     */
+    postedDate?: string;
+    /**
+     * The unique identifier of the deal.
+     * @type {string}
+     * @memberof SellerDealPaymentEvent
+     */
+    dealId?: string;
+    /**
+     * The internal description of the deal.
+     * @type {string}
+     * @memberof SellerDealPaymentEvent
+     */
+    dealDescription?: string;
+    /**
+     * The type of event: SellerDealComplete.
+     * @type {string}
+     * @memberof SellerDealPaymentEvent
+     */
+    eventType?: string;
+    /**
+     * The type of fee: RunLightningDealFee.
+     * @type {string}
+     * @memberof SellerDealPaymentEvent
+     */
+    feeType?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SellerDealPaymentEvent
+     */
+    feeAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SellerDealPaymentEvent
+     */
+    taxAmount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SellerDealPaymentEvent
+     */
+    totalAmount?: Currency;
+}

package/dist/types/src/api-model/models/seller-review-enrollment-payment-event.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { ChargeComponent } from './charge-component';
+import { Currency } from './currency';
+import { FeeComponent } from './fee-component';
+/**
+ * A fee payment event for the Early Reviewer Program.
+ * @export
+ * @interface SellerReviewEnrollmentPaymentEvent
+ */
+export interface SellerReviewEnrollmentPaymentEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    PostedDate?: string;
+    /**
+     * An enrollment identifier.
+     * @type {string}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    EnrollmentId?: string;
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program.
+     * @type {string}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    ParentASIN?: string;
+    /**
+     *
+     * @type {FeeComponent}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    FeeComponent?: FeeComponent;
+    /**
+     *
+     * @type {ChargeComponent}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    ChargeComponent?: ChargeComponent;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SellerReviewEnrollmentPaymentEvent
+     */
+    TotalAmount?: Currency;
+}

package/dist/types/src/api-model/models/service-fee-event.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { FeeComponent } from './fee-component';
+/**
+ * A service fee on the seller\'s account.
+ * @export
+ * @interface ServiceFeeEvent
+ */
+export interface ServiceFeeEvent {
+    /**
+     * An Amazon-defined identifier for an order.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    AmazonOrderId?: string;
+    /**
+     * A short description of the service fee reason.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    FeeReason?: string;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ServiceFeeEvent
+     */
+    FeeList?: Array<FeeComponent>;
+    /**
+     * The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    SellerSKU?: string;
+    /**
+     * A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    FnSKU?: string;
+    /**
+     * A short description of the service fee event.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    FeeDescription?: string;
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     * @type {string}
+     * @memberof ServiceFeeEvent
+     */
+    ASIN?: string;
+}

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

@@ -0,0 +1,100 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { ChargeComponent } from './charge-component';
+import { DirectPayment } from './direct-payment';
+import { FeeComponent } from './fee-component';
+import { ShipmentItem } from './shipment-item';
+/**
+ * A shipment, refund, guarantee claim, or chargeback.
+ * @export
+ * @interface ShipmentEvent
+ */
+export interface ShipmentEvent {
+    /**
+     * An Amazon-defined identifier for an order.
+     * @type {string}
+     * @memberof ShipmentEvent
+     */
+    AmazonOrderId?: string;
+    /**
+     * A seller-defined identifier for an order.
+     * @type {string}
+     * @memberof ShipmentEvent
+     */
+    SellerOrderId?: string;
+    /**
+     * The name of the marketplace where the event occurred.
+     * @type {string}
+     * @memberof ShipmentEvent
+     */
+    MarketplaceName?: string;
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof ShipmentEvent
+     */
+    OrderChargeList?: Array<ChargeComponent>;
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof ShipmentEvent
+     */
+    OrderChargeAdjustmentList?: Array<ChargeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentEvent
+     */
+    ShipmentFeeList?: Array<FeeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentEvent
+     */
+    ShipmentFeeAdjustmentList?: Array<FeeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentEvent
+     */
+    OrderFeeList?: Array<FeeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentEvent
+     */
+    OrderFeeAdjustmentList?: Array<FeeComponent>;
+    /**
+     * A list of direct payment information.
+     * @type {Array<DirectPayment>}
+     * @memberof ShipmentEvent
+     */
+    DirectPaymentList?: Array<DirectPayment>;
+    /**
+     *
+     * @type {string}
+     * @memberof ShipmentEvent
+     */
+    PostedDate?: string;
+    /**
+     * A list of shipment items.
+     * @type {Array<ShipmentItem>}
+     * @memberof ShipmentEvent
+     */
+    ShipmentItemList?: Array<ShipmentItem>;
+    /**
+     * A list of shipment items.
+     * @type {Array<ShipmentItem>}
+     * @memberof ShipmentEvent
+     */
+    ShipmentItemAdjustmentList?: Array<ShipmentItem>;
+}

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

@@ -0,0 +1,101 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { ChargeComponent } from './charge-component';
+import { Currency } from './currency';
+import { FeeComponent } from './fee-component';
+import { Promotion } from './promotion';
+import { TaxWithheldComponent } from './tax-withheld-component';
+/**
+ * An item of a shipment, refund, guarantee claim, or chargeback.
+ * @export
+ * @interface ShipmentItem
+ */
+export interface ShipmentItem {
+    /**
+     * The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
+     * @type {string}
+     * @memberof ShipmentItem
+     */
+    SellerSKU?: string;
+    /**
+     * An Amazon-defined order item identifier.
+     * @type {string}
+     * @memberof ShipmentItem
+     */
+    OrderItemId?: string;
+    /**
+     * An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events.
+     * @type {string}
+     * @memberof ShipmentItem
+     */
+    OrderAdjustmentItemId?: string;
+    /**
+     * The number of items shipped.
+     * @type {number}
+     * @memberof ShipmentItem
+     */
+    QuantityShipped?: number;
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof ShipmentItem
+     */
+    ItemChargeList?: Array<ChargeComponent>;
+    /**
+     * A list of charge information on the seller\'s account.
+     * @type {Array<ChargeComponent>}
+     * @memberof ShipmentItem
+     */
+    ItemChargeAdjustmentList?: Array<ChargeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentItem
+     */
+    ItemFeeList?: Array<FeeComponent>;
+    /**
+     * A list of fee component information.
+     * @type {Array<FeeComponent>}
+     * @memberof ShipmentItem
+     */
+    ItemFeeAdjustmentList?: Array<FeeComponent>;
+    /**
+     * A list of information about taxes withheld.
+     * @type {Array<TaxWithheldComponent>}
+     * @memberof ShipmentItem
+     */
+    ItemTaxWithheldList?: Array<TaxWithheldComponent>;
+    /**
+     * A list of promotions.
+     * @type {Array<Promotion>}
+     * @memberof ShipmentItem
+     */
+    PromotionList?: Array<Promotion>;
+    /**
+     * A list of promotions.
+     * @type {Array<Promotion>}
+     * @memberof ShipmentItem
+     */
+    PromotionAdjustmentList?: Array<Promotion>;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ShipmentItem
+     */
+    CostOfPointsGranted?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof ShipmentItem
+     */
+    CostOfPointsReturned?: Currency;
+}

package/dist/types/src/api-model/models/solution-provider-credit-event.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Selling Partner API for Finances
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
+ *
+ * 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 { Currency } from './currency';
+/**
+ * A credit given to a solution provider.
+ * @export
+ * @interface SolutionProviderCreditEvent
+ */
+export interface SolutionProviderCreditEvent {
+    /**
+     * The transaction type.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    ProviderTransactionType?: string;
+    /**
+     * A seller-defined identifier for an order.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    SellerOrderId?: string;
+    /**
+     * The identifier of the marketplace where the order was placed.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    MarketplaceId?: string;
+    /**
+     * The two-letter country code of the country associated with the marketplace where the order was placed.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    MarketplaceCountryCode?: string;
+    /**
+     * The Amazon-defined identifier of the seller.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    SellerId?: string;
+    /**
+     * The store name where the payment event occurred.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    SellerStoreName?: string;
+    /**
+     * The Amazon-defined identifier of the solution provider.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    ProviderId?: string;
+    /**
+     * The store name where the payment event occurred.
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    ProviderStoreName?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof SolutionProviderCreditEvent
+     */
+    TransactionAmount?: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof SolutionProviderCreditEvent
+     */
+    TransactionCreationDate?: string;
+}