POST /resellers.json

POST /resellers.json
application/json

Body Required

  • accountType string | null Required

    Account type

    Values are reseller or salesRep. Default value is reseller.

  • addressLineOne string | null

    Address line one

  • addressLineTwo string | null

    Address line two

  • city string | null

    City

  • country string | null

    Country

  • customerId integer(int32) | null

    Customer

  • customersScope string | null

    Customers scope

    Values are global or self.

  • firstName string | null

    First name

  • includeLandedCosts boolean | null

    Include landed costs

  • lastName string | null

    Last name

  • name string Required

    Name

  • paymentSchedule string | null Required

    Payment schedule

    Values are beforeFinalize or manual. Default value is beforeFinalize.

  • priceListId integer(int32) | null

    Price list

  • pricingType string | null Required

    Pricing type

    Values are channel or selected. Default value is channel.

  • qualificationStatus string | null Required

    Qualification status

    Values are pending, started, or complete. Default value is pending.

  • source string | null

    Source

    Values are application, manual, or migration.

  • state string | null

    State

  • status string | null Required

    Status

    Values are pending, active, archived, or rejected. Default value is active.

  • stripeCustomerId string | null

    Stripe customer

  • tags array[string] | null

    Tags

  • taxCalculation string | null Required

    Tax calculation

    Values are channel, taxRate, or disabled. Default value is channel.

  • taxCalculationDuration string | null Required

    Tax calculation duration

    Values are rolling or fixed. Default value is rolling.

  • taxCalculationExpiration string(date-time) | null

    Tax calculation expiration

  • zip string | null

    Zip

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • accountType string | null Required

      Account type

      Values are reseller or salesRep. Default value is reseller.

    • addressLineOne string | null

      Address line one

    • addressLineTwo string | null

      Address line two

    • city string | null

      City

    • country string | null

      Country

    • createdAt string(date-time)

      Created at

    • customerId integer(int32) | null

      Customer

    • customersScope string | null

      Customers scope

      Values are global or self.

    • firstName string | null

      First name

    • id integer(int32)

      Id

    • includeLandedCosts boolean | null

      Include landed costs

    • lastName string | null

      Last name

    • name string Required

      Name

    • paymentSchedule string | null Required

      Payment schedule

      Values are beforeFinalize or manual. Default value is beforeFinalize.

    • priceListId integer(int32) | null

      Price list

    • pricingType string | null Required

      Pricing type

      Values are channel or selected. Default value is channel.

    • qualificationStatus string | null Required

      Qualification status

      Values are pending, started, or complete. Default value is pending.

    • source string | null

      Source

      Values are application, manual, or migration.

    • state string | null

      State

    • status string | null Required

      Status

      Values are pending, active, archived, or rejected. Default value is active.

    • stripeCustomerId string | null

      Stripe customer

    • tags array[string] | null

      Tags

    • taxCalculation string | null Required

      Tax calculation

      Values are channel, taxRate, or disabled. Default value is channel.

    • taxCalculationDuration string | null Required

      Tax calculation duration

      Values are rolling or fixed. Default value is rolling.

    • taxCalculationExpiration string(date-time) | null

      Tax calculation expiration

    • updatedAt string(date-time)

      Updated at

    • zip string | null

      Zip

POST /resellers.json
curl \
 --request POST 'http://api.example.com/v1/resellers.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"accountType":"reseller","addressLineOne":"string","addressLineTwo":"string","city":"string","country":"string","customerId":42,"customersScope":"global","firstName":"string","includeLandedCosts":true,"lastName":"string","name":"string","paymentSchedule":"beforeFinalize","priceListId":42,"pricingType":"channel","qualificationStatus":"pending","source":"application","state":"string","status":"active","stripeCustomerId":"string","tags":["string"],"taxCalculation":"channel","taxCalculationDuration":"rolling","taxCalculationExpiration":"2025-05-04T09:42:00Z","zip":"string"}'
Request examples
{
  "accountType": "reseller",
  "addressLineOne": "string",
  "addressLineTwo": "string",
  "city": "string",
  "country": "string",
  "customerId": 42,
  "customersScope": "global",
  "firstName": "string",
  "includeLandedCosts": true,
  "lastName": "string",
  "name": "string",
  "paymentSchedule": "beforeFinalize",
  "priceListId": 42,
  "pricingType": "channel",
  "qualificationStatus": "pending",
  "source": "application",
  "state": "string",
  "status": "active",
  "stripeCustomerId": "string",
  "tags": [
    "string"
  ],
  "taxCalculation": "channel",
  "taxCalculationDuration": "rolling",
  "taxCalculationExpiration": "2025-05-04T09:42:00Z",
  "zip": "string"
}
Response examples (200)
{
  "accountType": "reseller",
  "addressLineOne": "string",
  "addressLineTwo": "string",
  "city": "string",
  "country": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "customerId": 42,
  "customersScope": "global",
  "firstName": "string",
  "id": 42,
  "includeLandedCosts": true,
  "lastName": "string",
  "name": "string",
  "paymentSchedule": "beforeFinalize",
  "priceListId": 42,
  "pricingType": "channel",
  "qualificationStatus": "pending",
  "source": "application",
  "state": "string",
  "status": "active",
  "stripeCustomerId": "string",
  "tags": [
    "string"
  ],
  "taxCalculation": "channel",
  "taxCalculationDuration": "rolling",
  "taxCalculationExpiration": "2025-05-04T09:42:00Z",
  "updatedAt": "2025-05-04T09:42:00Z",
  "zip": "string"
}