Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • 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

    Email

  • fax string | null

    Fax

    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)

    Id

  • lastName string | null

    Last name

  • name string Required

    Name

  • noInventoryPolicy string | null Required

    No inventory policy

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

  • notes string | null

    Notes

  • orderEmail string | null

    Order email

  • paymentDays integer(int32) | null Required

    Payment days

    Default value is 0.

  • phone string | null

    Phone

    Maximum length is 30.

  • returnsEmail string | null

    Returns email

  • source string | null Required

    Source

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

  • specifyDropshipProviders boolean Required

    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

    Warehouse

  • warehouseRouting string | null Required

    Warehouse routing

    Values are select or routed. Default value is select.

  • xeroId string | null

    Xero