Sellers API v1 model

Swagger model for Sellers API v1.

{
  "swagger": "2.0",
  "info": {
    "description": "The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace.",
    "version": "v1",
    "title": "Selling Partner API for Sellers",
    "contact": {
      "name": "Selling Partner API Developer Support",
      "url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
    },
    "license": {
      "name": "Apache License 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0"
    }
  },
  "host": "sellingpartnerapi-na.amazon.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/sellers/v1/marketplaceParticipations": {
      "get": {
        "tags": [
          "sellers"
        ],
        "description": "Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| .016 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
        "operationId": "getMarketplaceParticipations",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Marketplace participations successfully retrieved.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "examples": {
              "payload": [
                {
                  "marketplace": {
                    "id": "ATVPDKIKX0DER",
                    "name": "Amazon.com",
                    "countryCode": "US",
                    "defaultCurrencyCode": "USD",
                    "defaultLanguageCode": "en_US",
                    "domainName": "www.amazon.com"
                  },
                  "participation": {
                    "isParticipating": true,
                    "hasSuspendedListings": false
                  }
                }
              ]
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "unique request reference id."
              }
            },
            "x-amzn-api-sandbox": {
              "static": [
                {
                  "request": {
                    "parameters": {}
                  },
                  "response": {
                    "payload": [
                      {
                        "marketplace": {
                          "id": "ATVPDKIKX0DER",
                          "countryCode": "US",
                        "name": "Amazon.com",
                        "defaultCurrencyCode": "USD",
                        "defaultLanguageCode": "en_US",
                          "domainName": "www.amazon.com"
                        },
                        "participation": {
                          "isParticipating": true,
                          "hasSuspendedListings": false
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "403": {
            "description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "413": {
            "description": "The request size exceeded the maximum accepted size.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "415": {
            "description": "The entity of the request is in a format not supported by the requested resource.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "500": {
            "description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          },
          "503": {
            "description": "Temporary overloading or maintenance of the server.",
            "schema": {
              "$ref": "#/definitions/GetMarketplaceParticipationsResponse"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "type": "string",
                "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
              },
              "x-amzn-RequestId": {
                "type": "string",
                "description": "Unique request reference id."
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "An error code that identifies the type of error that occured."
        },
        "message": {
          "type": "string",
          "description": "A message that describes the error condition in a human-readable form."
        },
        "details": {
          "type": "string",
          "description": "Additional details that can help the caller understand or fix the issue."
        }
      },
      "description": "Error response returned when the request is unsuccessful."
    },
    "ErrorList": {
      "type": "array",
      "description": "A list of error responses returned when a request is unsuccessful.",
      "items": {
        "$ref": "#/definitions/Error"
      }
    },
    "MarketplaceParticipation": {
      "type": "object",
      "required": [
        "marketplace",
        "participation"
      ],
      "properties": {
        "marketplace": {
          "$ref": "#/definitions/Marketplace"
        },
        "participation": {
          "$ref": "#/definitions/Participation"
        }
      }
    },
    "MarketplaceParticipationList": {
      "type": "array",
      "description": "List of marketplace participations.",
      "items": {
        "$ref": "#/definitions/MarketplaceParticipation"
      }
    },
    "GetMarketplaceParticipationsResponse": {
      "type": "object",
      "properties": {
        "payload": {
          "description": "The payload for the getMarketplaceParticipations operation.",
          "$ref": "#/definitions/MarketplaceParticipationList"
        },
        "errors": {
          "description": "Encountered errors for the getMarketplaceParticipations operation.",
          "$ref": "#/definitions/ErrorList"
        }
      },
      "description": "The response schema for the getMarketplaceParticipations operation."
    },
    "Marketplace": {
      "type": "object",
      "required": [
        "countryCode",
        "defaultCurrencyCode",
        "defaultLanguageCode",
        "domainName",
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The encrypted marketplace value."
        },
        "name": {
          "type": "string",
          "description": "Marketplace name."
        },
        "countryCode": {
          "type": "string",
          "description": "The ISO 3166-1 alpha-2 format country code of the marketplace.",
          "pattern": "^([A-Z]{2})$"
        },
        "defaultCurrencyCode": {
          "type": "string",
          "description": "The ISO 4217 format currency code of the marketplace."
        },
        "defaultLanguageCode": {
          "type": "string",
          "description": "The ISO 639-1 format language code of the marketplace."
        },
        "domainName": {
          "type": "string",
          "description": "The domain name of the marketplace."
        }
      },
      "description": "Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items."
    },
    "Participation": {
      "type": "object",
      "required": [
        "hasSuspendedListings",
        "isParticipating"
      ],
      "properties": {
        "isParticipating": {
          "type": "boolean"
        },
        "hasSuspendedListings": {
          "type": "boolean",
          "description": "Specifies if the seller has suspended listings. True if the seller Listing Status is set to Inactive, otherwise False."
        }
      },
      "description": "Detailed information that is specific to a seller in a Marketplace."
    }
  }
}


Did this page help you?