---
agentTools:
  projectIndex: https://developer.mxmerchant.com/llms.txt
---

# Create Supplier

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Checkout API",
    "version": "1.00"
  },
  "servers": [
    {
      "url": "https://sandbox.api.mxmerchant.com/checkout"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v3/supplier": {
      "post": {
        "summary": "Create Supplier",
        "description": "",
        "operationId": "create-a-supplier",
        "parameters": [
          {
            "name": "echo",
            "in": "query",
            "description": "Returns data",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "catalogId"
                ],
                "properties": {
                  "catalogId": {
                    "type": "integer",
                    "description": "Catalog Id",
                    "format": "int32"
                  },
                  "merchantId": {
                    "type": "integer",
                    "description": "Merchant Id",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "description": "Supplier Name"
                  },
                  "number": {
                    "type": "string",
                    "description": "Supplier number"
                  },
                  "supplierApplicationType": {
                    "type": "string"
                  },
                  "supplierRateType": {
                    "type": "string"
                  },
                  "supplierType": {
                    "type": "string"
                  },
                  "taxId": {
                    "type": "string",
                    "description": "Tax Id"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\": 9840,\n    \"merchantId\": 939458974,\n    \"catalogId\": 1343896,\n    \"name\": \"Johnson's Supplier\",\n    \"number\": \"1234567890\",\n    \"taxId\": \"*****6789\",\n    \"created\": \"2020-10-06T15:45:48.197Z\",\n    \"lastActivity\": \"2020-10-06T15:45:48.197Z\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 9840,
                      "default": 0
                    },
                    "merchantId": {
                      "type": "integer",
                      "example": 939458974,
                      "default": 0
                    },
                    "catalogId": {
                      "type": "integer",
                      "example": 1343896,
                      "default": 0
                    },
                    "name": {
                      "type": "string",
                      "example": "Johnson's Supplier"
                    },
                    "number": {
                      "type": "string",
                      "example": "1234567890"
                    },
                    "taxId": {
                      "type": "string",
                      "example": "*****6789"
                    },
                    "created": {
                      "type": "string",
                      "example": "2020-10-06T15:45:48.197Z"
                    },
                    "lastActivity": {
                      "type": "string",
                      "example": "2020-10-06T15:45:48.197Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "644bb860dd3d4600261d0de7:644bb860dd3d4600261d0e84"
}
```