PUT /vendors/{id}.json

PUT /vendors/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.


Body Required

  • accountsEmail string | null

    Accounts email

  • automaticallyBackorder string | null Required

    Automatically backorder

    Values are company_default, backorder, or ignore. Default value is company_default.

  • companyCode string | null

    Company code

    Maximum length is 30.

  • createdAt string(date-time)

    Created at

  • currencyId integer(int32) | null

    Cost prices will be converted at this currency on purchase orders. You can either use fixed or automatic exchange rates. Currencies can be added under Setup > Currencies then assigned here.

  • deliveryDays integer(int32) | null Required

    Delivery days

    Default value is 0.

  • dropshipProcessing string | null Required

    Dropship processing

    Values are direct or dropship_provider. Default value is dropship_provider.

  • email string | null


  • fax string | null


    Maximum length is 30.

  • firstName string | null

    First name

  • fulfillmentPolicy string | null Required

    Fulfillment policy

    Values are manual, dropship, fulfill, company_default, or blended. Default value is company_default.

  • id integer(int32)


  • lastName string | null

    Last name

  • name string Required


  • noInventoryPolicy string | null Required

    No inventory policy

    Values are manual, dropship, or replenish. Default value is manual.

  • notes string | null


  • orderEmail string | null

    Order email

  • paymentDays integer(int32) | null Required

    Payment days

    Default value is 0.

  • phone string | null


    Maximum length is 30.

  • returnsEmail string | null

    Returns email

  • source string | null Required


    Values are channel, manual, dropshipProvider, or invenotryFeed. Default value is channel.

  • Specify dropship providers

    Default value is true.

  • taxNumber string | null

    Tax number

    Maximum length is 30.

  • updatedAt string(date-time)

    Updated at

  • warehouseId integer(int32) | null


  • warehouseRouting string | null Required

    Warehouse routing

    Values are select or routed. Default value is select.

  • xeroId string | null


PUT /vendors/{id}.json
curl \
 -X PUT http://api.example.com/v1/vendors/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"accountsEmail":"string","automaticallyBackorder":"company_default","companyCode":"string","createdAt":"2024-05-04T09:42:00+00:00","currencyId":42,"deliveryDays":0,"dropshipProcessing":"dropship_provider","email":"string","fax":"string","firstName":"string","fulfillmentPolicy":"company_default","id":42,"lastName":"string","name":"string","noInventoryPolicy":"manual","notes":"string","orderEmail":"string","paymentDays":0,"phone":"string","returnsEmail":"string","source":"channel","specifyDropshipProviders":true,"taxNumber":"string","updatedAt":"2024-05-04T09:42:00+00:00","warehouseId":42,"warehouseRouting":"select","xeroId":"string"}'
Request example
  "accountsEmail": "string",
  "automaticallyBackorder": "company_default",
  "companyCode": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "currencyId": 42,
  "deliveryDays": 0,
  "dropshipProcessing": "dropship_provider",
  "email": "string",
  "fax": "string",
  "firstName": "string",
  "fulfillmentPolicy": "company_default",
  "id": 42,
  "lastName": "string",
  "name": "string",
  "noInventoryPolicy": "manual",
  "notes": "string",
  "orderEmail": "string",
  "paymentDays": 0,
  "phone": "string",
  "returnsEmail": "string",
  "source": "channel",
  "specifyDropshipProviders": true,
  "taxNumber": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "warehouseId": 42,
  "warehouseRouting": "select",
  "xeroId": "string"