---
updatedAt: 2025-06-10T23:44:00.000Z
agentTools:
  projectIndex: https://docs.supplierxm.salsify.com/llms.txt
---

# Supplier List

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "supplier",
    "version": "2.1"
  },
  "servers": [
    {
      "url": "https://apis.supplierxm.salsify.com/public/v1/supplier"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "SALSIFY_TOKEN"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/list": {
      "post": {
        "summary": "Supplier List",
        "description": "",
        "operationId": "supplier-list",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "internal_ids": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "limit": {
                    "type": "integer",
                    "default": 20,
                    "format": "int32"
                  },
                  "offset": {
                    "type": "integer",
                    "default": 0,
                    "format": "int32"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Success": {
                    "value": "{\n  \"data\": [\n    {\n      \"id\": 1,\n      \"internalId\": \"supplier_1\",\n      \"name\": \"Supplier 1\",\n      \"matches\": [\n        {\n          \"organization\": {\n            \"id\": 10,\n            \"name\": \"Manufacturer 1\"\n          },\n          \"reasons\": {\n            \"method\": \"automatic\",\n            \"sirens\": [\n              \"123456789\"\n            ]\n          },\n          \"status\": \"VALIDATED\",\n          \"lastValidatedAt\": \"2020-01-01T00:00:00Z\",\n          \"createdAt\": \"2020-01-01T00:00:00Z\",\n          \"updatedAt\": \"2020-01-01T00:00:00Z\"\n        }\n      ],\n      \"sirens\": [\n        \"123456789\"\n      ],\n      \"vatNumbers\": [\n        \"FR0123456\"\n      ],\n      \"supplierIDs\": [\n        \"Supplier id 1\"\n      ],\n      \"supplyChains\": [\n        \"Supply chain 1\"\n      ],\n      \"createdAt\": \"2020-01-01T00:00:00Z\",\n      \"updatedAt\": \"2020-01-01T00:00:00Z\"\n    }\n  ],\n  \"totalResults\": 1\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "internalId": {
                            "type": "string",
                            "example": "supplier_1"
                          },
                          "name": {
                            "type": "string",
                            "example": "Supplier 1"
                          },
                          "matches": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "organization": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "integer",
                                      "example": 10,
                                      "default": 0
                                    },
                                    "name": {
                                      "type": "string",
                                      "example": "Manufacturer 1"
                                    }
                                  }
                                },
                                "reasons": {
                                  "type": "object",
                                  "properties": {
                                    "method": {
                                      "type": "string",
                                      "example": "automatic"
                                    },
                                    "sirens": {
                                      "type": "array",
                                      "items": {
                                        "type": "string",
                                        "example": "123456789"
                                      }
                                    }
                                  }
                                },
                                "status": {
                                  "type": "string",
                                  "example": "VALIDATED"
                                },
                                "lastValidatedAt": {
                                  "type": "string",
                                  "example": "2020-01-01T00:00:00Z"
                                },
                                "createdAt": {
                                  "type": "string",
                                  "example": "2020-01-01T00:00:00Z"
                                },
                                "updatedAt": {
                                  "type": "string",
                                  "example": "2020-01-01T00:00:00Z"
                                }
                              }
                            }
                          },
                          "sirens": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "123456789"
                            }
                          },
                          "vatNumbers": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "FR0123456"
                            }
                          },
                          "supplierIDs": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "Supplier id 1"
                            }
                          },
                          "supplyChains": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "Supply chain 1"
                            }
                          },
                          "createdAt": {
                            "type": "string",
                            "example": "2020-01-01T00:00:00Z"
                          },
                          "updatedAt": {
                            "type": "string",
                            "example": "2020-01-01T00:00:00Z"
                          }
                        }
                      }
                    },
                    "totalResults": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "With error": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```