Skip to main content
Amazon Selling Partner logo

Overview

Add Amazon Selling Partner to any ModuleX agent or workflow. Manage orders, inventory, pricing, and reports on Amazon marketplaces via the Amazon Selling Partner API (sellingpartnerapi-na.amazon.com).
Categories: E-Commerce · Marketplace · Fulfillment · Auth: OAuth2 · Actions: 8

Authentication

OAuth2 Authentication

Connect using Amazon Selling Partner OAuth (Login with Amazon)

Required Credentials

FieldDescriptionRequiredFormat
Client IDAmazon SP-API OAuth App Client ID from your developer applicationYes-
Client SecretAmazon SP-API OAuth App Client SecretYes-
SP-API Base URLSelling Partner API regional endpoint. Use https://sellingpartnerapi-na.amazon.com for North America (default), https://sellingpartnerapi-eu.amazon.com for Europe, or https://sellingpartnerapi-fe.amazon.com for the Far East. Pick the endpoint that matches your seller account’s region.Yeshttps://sellingpartnerapi-na.amazon.com

OAuth Configuration

  • Authorization URL: https://www.amazon.com/ap/oa
  • Token URL: https://api.amazon.com/auth/o2/token

Available Actions

Parameters

marketplace_id
string
required
The Amazon Marketplace ID (e.g. ATVPDKIKX0DER for US)
details
boolean
Set to true to return inventory summaries with additional summarized inventory details and quantities (Default: false)
start_date_time
string
A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. Must be no earlier than 18 months prior to the current date.
seller_skus
array
A list of seller SKUs for which to return inventory summaries (up to 50 SKUs). Elements are strings.

Response

{
  "$defs": {
    "InventorySummary": {
      "additionalProperties": false,
      "properties": {
        "asin": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Asin"
        },
        "fn_sku": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Fn Sku"
        },
        "seller_sku": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Seller Sku"
        },
        "condition": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Condition"
        },
        "total_quantity": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Total Quantity"
        },
        "product_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Product Name"
        }
      },
      "title": "InventorySummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "inventory_summaries": {
      "items": {
        "$ref": "#/$defs/InventorySummary"
      },
      "title": "Inventory Summaries",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CheckFbaInventoryLevelsOutput",
  "type": "object"
}

Parameters

marketplace_id
string
required
The Amazon Marketplace ID
created_after
string
required
Fetch orders created after this ISO date
created_before
string
Fetch orders created before this ISO date
buyer_email
string
The email address of a buyer to filter orders
amazon_order_id
string
An order identifier specified by the seller. If provided, other filters like FulfillmentChannels, OrderStatuses, PaymentMethod cannot be used.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "orders": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Orders",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "FetchOrdersByDateRangeOutput",
  "type": "object"
}

Parameters

report_types
array
required
A list of report types used to filter reports. Refer to SP-API Report Type Values documentation. Elements are strings.
marketplace_id
string
The Amazon Marketplace ID to filter reports
processing_statuses
array
A list of processing statuses used to filter reports. Valid values: CANCELLED, DONE, FATAL, IN_PROGRESS, IN_QUEUE. Elements are strings.
created_since
string
The earliest report creation date and time in ISO 8601 format. Default is 90 days ago.
created_until
string
The latest report creation date and time in ISO 8601 format. Default is now.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "reports": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Reports",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GenerateSalesInventoryReportsOutput",
  "type": "object"
}

Parameters

marketplace_id
string
required
The Amazon Marketplace ID
amazon_order_id
string
required
The Amazon order ID to fetch details for

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "order": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Order"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetOrderDetailsOutput",
  "type": "object"
}

Parameters

marketplace_id
string
required
The Amazon Marketplace ID
status
array
required
Filter inbound shipments by status. Valid values: WORKING, SHIPPED, RECEIVING, CANCELLED, DELETED, CLOSED, ERROR, IN_TRANSIT, DELIVERED, CHECKED_IN. Elements are strings.
last_updated_after
string
A date for selecting inbound shipments that were last updated after (or at) a specified time
last_updated_before
string
A date for selecting inbound shipments that were last updated before (or at) a specified time

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "shipments": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Shipments",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListInboundShipmentsOutput",
  "type": "object"
}

Response

{
  "$defs": {
    "MarketplaceOption": {
      "additionalProperties": false,
      "properties": {
        "label": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Label"
        },
        "value": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Value"
        }
      },
      "title": "MarketplaceOption",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "marketplaces": {
      "items": {
        "$ref": "#/$defs/MarketplaceOption"
      },
      "title": "Marketplaces",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListMarketplaceIdOptionsOutput",
  "type": "object"
}

Parameters

marketplace_id
string
required
The Amazon Marketplace ID
interval
string
required
A time interval for selecting order metrics. Two dates separated by two hyphens (first date inclusive; second exclusive) in ISO8601 format. Example: 2018-09-01T00:00:00-07:00—2018-09-04T00:00:00-07:00
granularity
string
required
The granularity of the grouping of order metrics. Valid values: Hour, Day, Week, Month, Year, Total
granularity_time_zone
string
An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour.
buyer_type
string
Filters results by buyer type. Valid values: All, B2B, B2C
fulfillment_network
string
Filters results by fulfillment network. Valid values: MFN (merchant fulfillment), AFN (Amazon fulfillment)
first_day_of_week
string
Specifies the day that the week starts on when granularity=Week. Valid values: Monday, Sunday. Default: Monday
asin
string
Filters results by ASIN. Cannot be specified together with sku.
sku
string
Filters results by SKU. Cannot be specified together with asin.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "order_metrics": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Order Metrics",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "RetrieveSalesPerformanceReportsOutput",
  "type": "object"
}

Limits & Quotas

  • SP-API enforces per-endpoint rate limits varying by selling partner type (standard vs. grantless). Typical burst: 1-30 requests/second depending on the endpoint.
  • Orders API: 1 request per second burst, with a restore rate of 1 request per second.
  • Inventory API: 2 requests per second burst.
  • Pricing API: 10 requests per 1 second burst (for getCompetitivePrice).
  • Reports API: varies per report type; creation is throttled at a lower rate than retrieval.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Etsy

Google Merchant Center

Instacart