Add a Vendor

POST /vendors

Api key auth

Add a new vendor

application/json

Body

vendor object
Hide vendor attributes Show vendor attributes object
- name string
- minimum_order_value number
- minimum_order_quantity integer(int32)
- address1 string
- address2 string | null
- city string
- state string(ISO 3166-2)
- zip string
- country string(ISO 3166-1 alpha-2)
- website string | null
- email string | null
- phone string | null
- ein string | null
- order_contact_name string | null
- order_contact_phone string(phone)
- payment_contact_name string | null
- payment_contact_phone string(phone) | null
- shipping_type string | null
- shipping_scheme object
  Hide shipping_scheme attribute Show shipping_scheme attribute object
  
  0 string | null
- status string
- order_processing_time string | null
- order_processing_on string | null
- order_shipping_days array[object]
- order_processing_cut_off_time string | null
- order_terms string | null
- description string | null
  
  excluded from index
- logo string | null

Responses

201 application/json

Vendor created
Hide response attributes Show response attributes object
- id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
- name string
- minimum_order_value number
- minimum_order_quantity integer(int32)
- address1 string
- address2 string | null
- city string
- state string(ISO 3166-2)
- zip string
- country string(ISO 3166-1 alpha-2)
- website string | null
- email string | null
- phone string | null
- ein string | null
- order_contact_name string | null
- order_contact_phone string(phone)
- payment_contact_name string | null
- payment_contact_phone string(phone) | null
- shipping_type string | null
- shipping_scheme object
  
  Hide shipping_scheme attribute Show shipping_scheme attribute object
  
  0 string | null
- status string
- order_processing_time string | null
- order_processing_on string | null
- order_shipping_days array[object]
- order_processing_cut_off_time string | null
- order_terms string | null
- description string | null
  
  excluded from index
- logo string | null
- created_at string(date-time)
- updated_at string(date-time)
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- error string
  
  401: Invalid Credentials
  
  404: Resource not found
  
  422: Unprocessable Entity
- details string
  
  404: empty
  
  401: The credentials presented are not valid to access this resource
422 application/json

Unprocessable Entity
Hide response attributes Show response attributes object
- error string
  
  401: Invalid Credentials
  
  404: Resource not found
  
  422: Unprocessable Entity
- details string
  
  404: empty
  
  401: The credentials presented are not valid to access this resource

POST /vendors

curl \
 --request POST 'https://app.getfoundation.com/api/external/v1/vendors' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"vendor":{"name":"Acme Corp","minimum_order_value":200,"minimum_order_quantity":10,"address1":"123 Main St","address2":"string","city":"Seattle","state":"WA","zip":98101,"country":"US","website":"string","email":"string","phone":"string","ein":"string","order_contact_name":"string","order_contact_phone":"string","payment_contact_name":"John Doe","payment_contact_phone":"string","shipping_type":"VendorCalculators::Shipping::SubtotalBased","shipping_scheme":{"0":"string"},"status":"active","order_processing_time":"string","order_processing_on":"string","order_shipping_days":[{}],"order_processing_cut_off_time":"string","order_terms":"string","description":"string","logo":"string"}}'

Request examples

{
  "vendor": {
    "name": "Acme Corp",
    "minimum_order_value": 200,
    "minimum_order_quantity": 10,
    "address1": "123 Main St",
    "address2": "string",
    "city": "Seattle",
    "state": "WA",
    "zip": 98101,
    "country": "US",
    "website": "string",
    "email": "string",
    "phone": "string",
    "ein": "string",
    "order_contact_name": "string",
    "order_contact_phone": "string",
    "payment_contact_name": "John Doe",
    "payment_contact_phone": "string",
    "shipping_type": "VendorCalculators::Shipping::SubtotalBased",
    "shipping_scheme": {
      "0": "string"
    },
    "status": "active",
    "order_processing_time": "string",
    "order_processing_on": "string",
    "order_shipping_days": [
      {}
    ],
    "order_processing_cut_off_time": "string",
    "order_terms": "string",
    "description": "string",
    "logo": "string"
  }
}

Response examples (201)

{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "name": "Acme Corp",
  "minimum_order_value": 200,
  "minimum_order_quantity": 10,
  "address1": "123 Main St",
  "address2": "string",
  "city": "Seattle",
  "state": "WA",
  "zip": 98101,
  "country": "US",
  "website": "string",
  "email": "string",
  "phone": "string",
  "ein": "string",
  "order_contact_name": "string",
  "order_contact_phone": "string",
  "payment_contact_name": "John Doe",
  "payment_contact_phone": "string",
  "shipping_type": "VendorCalculators::Shipping::SubtotalBased",
  "shipping_scheme": {
    "0": "string"
  },
  "status": "active",
  "order_processing_time": "string",
  "order_processing_on": "string",
  "order_shipping_days": [
    {}
  ],
  "order_processing_cut_off_time": "string",
  "order_terms": "string",
  "description": "string",
  "logo": "string",
  "created_at": "2025-05-04T09:42:00Z",
  "updated_at": "2025-05-04T09:42:00Z"
}

Response examples (401)

{
  "error": "string",
  "details": "string"
}

Response examples (422)

{
  "error": "string",
  "details": "string"
}