address-validation

PUT /accounting-integrations/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

createdAt string(date-time)

Created at
dropshipEndpoint string | null

Dropship endpoint
id integer(int32)

Id
name string Required

Name
replenishmentEndpoint string | null

Replenishment endpoint
saleEndpoint string | null

Sale endpoint
updatedAt string(date-time)

Updated at

PUT /accounting-integrations/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/accounting-integrations/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"createdAt":"2025-05-04T09:42:00Z","dropshipEndpoint":"string","id":42,"name":"string","replenishmentEndpoint":"string","saleEndpoint":"string","updatedAt":"2025-05-04T09:42:00Z"}'

Request examples

{
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2025-05-04T09:42:00Z"
}

DELETE /channel-dropship-locations/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

DELETE /channel-dropship-locations/{id}.json

curl \
 --request DELETE 'http://api.example.com/v1/channel-dropship-locations/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

POST /currencies.json

Bearer auth

application/json

Body Required

exchangeRate number(float) Required

Exchange rate

Default value is 1.
iso string Required

Iso
name string Required

Name
roundUp boolean | null Required

Round up

Default value is false.
symbol string Required

Symbol
useLiveRates boolean | null Required

Use live rates

Default value is true.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- exchangeRate number(float) Required
  
  Exchange rate
  
  Default value is 1.
- id integer(int32)
  
  Id
- iso string Required
  
  Iso
- name string Required
  
  Name
- roundUp boolean | null Required
  
  Round up
  
  Default value is false.
- symbol string Required
  
  Symbol
- updatedAt string(date-time)
  
  Updated at
- useLiveRates boolean | null Required
  
  Use live rates
  
  Default value is true.

POST /currencies.json

curl \
 --request POST 'http://api.example.com/v1/currencies.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"exchangeRate":1,"iso":"string","name":"string","roundUp":false,"symbol":"string","useLiveRates":true}'

Request examples

{
  "exchangeRate": 1,
  "iso": "string",
  "name": "string",
  "roundUp": false,
  "symbol": "string",
  "useLiveRates": true
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "exchangeRate": 1,
  "id": 42,
  "iso": "string",
  "name": "string",
  "roundUp": false,
  "symbol": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "useLiveRates": true
}

DELETE /dropship-locations/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

DELETE /dropship-locations/{id}.json

curl \
 --request DELETE 'http://api.example.com/v1/dropship-locations/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

DELETE /options/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

DELETE /options/{id}.json

curl \
 --request DELETE 'http://api.example.com/v1/options/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

POST /purchases.json

Bearer auth

application/json

Body Required

adjustmentReasonId integer(int32) | null

Adjustment reason
adminNotes string | null

Admin notes
approved boolean Required

Approved

Default value is true.
billingAddressLineOne string | null

Billing address line one
billingAddressLineTwo string | null

Billing address line two
billingAddressMessage string | null

Billing address message
billingCity string | null

Billing city
billingCountry string | null

Billing country
billingFirstName string | null

Billing first name
billingFullName object | null | array | boolean | integer | number | string

Billing full name

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
billingLastName string | null

Billing last name
billingName string | null

Billing name
billingState string | null

Billing state
billingZip string | null

Billing zip
cancellationStatus string Required

Cancellation status

Values are none, partial, or full. Default value is none.
cancelled boolean Required

Cancelled

Default value is false.
cancelledAt string(date-time) | null

Cancelled at
cityTaxLocation string | null

City tax location
cityTaxRate number(float) | null

City tax rate
combinedTaxRate number(float) | null

Combined tax rate
countyTaxLocation string | null

County tax location
countyTaxRate number(float) | null

County tax rate
customerReference string | null

Customer reference
dateOrdered string(date-time) Required

Date ordered

Default value is {} (empty).
deliveryExpectedAt string(date-time) | null

Delivery expected at
discounts number Required

Discounts

Default value is 0.
districtTaxRate number(float) | null

District tax rate
dropshipNotes string | null

Dropship notes
dropshipProviderAddressId integer(int32) | null

Dropship provider address
dropshipProviderId integer(int32) | null

Dropship provider
files object | null | array | boolean | integer | number | string

Files

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
finalized boolean Required

Finalized

Default value is true.
intercomMessageId string | null

Intercom message
internalReference string | null

Internal reference
invalidBillingAddress string | null

Invalid billing address
invalidShippingAddress boolean | null Required

Invalid shipping address

Default value is false.
inventoryStatus string Required

Inventory status

Values are notReceived, partiallyReceived, or received. Default value is notReceived.
invoiceProblem object | null | array | boolean | integer | number | string

Invoice problem

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
invoiceStatus string Required

Invoice status

Values are notInvoiced, partiallyInvoiced, or invoiced. Default value is notInvoiced.
isDropship boolean Required

Is dropship
labelProblem object | null | array | boolean | integer | number | string

Label problem

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
lastDropshipmentReference integer(int32) | null Required

Last dropshipment reference

Default value is 0.
lastGoodsReceiptReference integer(int32) | null Required

Last goods receipt reference

Default value is 0.
lastPurchaseInvoiceReference integer(int32) | null Required

Last purchase invoice reference

Default value is 0.
locked boolean Required

Locked

Default value is false.
muteError boolean | null Required

Mute error

Default value is false.
notes string | null

Notes
orderProblem object | null | array | boolean | integer | number | string

Order problem

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
orderSplitting string | null Required

Order splitting

Values are group, splitTag, splitQuantity, or externalLocationId. Default value is group.
orderSplittingKey string | null

Order splitting key
pauseProblems object | null | array | boolean | integer | number | string

Pause problems

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
paymentExpectedAt string(date-time) | null

Payment expected at
paymentStatus string Required

Payment status

Values are notPaid, partiallyPaid, or paid. Default value is notPaid.
priceListId integer(int32) | null

Price list
purchaseId integer(int32) | null

Purchase
purchaseImportExternalId string | null

Purchase import external
purchaseStatusId integer(int32) | null

Purchase status
purchaseType string Required

Purchase type

Values are replenishment, dropship, automated_dropship, automated_replenishment, or adjusted_dropship. Default value is replenishment.
quantity integer(int32) Required

Quantity

Default value is 0.
receiverAddressLineOne string | null

Receiver address line one
receiverAddressLineTwo string | null

Receiver address line two
receiverCity string | null

Receiver city
receiverCountry string | null

Receiver country
receiverName string | null

Receiver name
receiverState string | null

Receiver state
receiverZip string | null

Receiver zip
reference string Required

Reference
reminderLastSent string(date-time) | null

Reminder last sent
reminderSent integer(int32) | null Required

Reminder sent

Default value is false.
returnLabelProblem object | null | array | boolean | integer | number | string

Return label problem

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
returnStatus string Required

Return status

Values are notReturned, partiallyReturned, or returned. Default value is notReturned.
saleId integer(int32) | null

Sale
sendSource string | null

Send source

Values are manual or automatic.
shipmentRouting string | null Required

Shipment routing

Values are customer, consolidated, or consolidatedInternational. Default value is customer.
shippingAddressLineOne string | null

Shipping address line one
shippingAddressLineTwo string | null

Shipping address line two
shippingAddressMessage boolean | null Required

Shipping address message

Default value is false.
shippingCity string | null

Shipping city
shippingCountry string | null

Shipping country
shippingExpectedAt string(date-time) | null

Shipping expected at
shippingFirstName string | null

Shipping first name
shippingFullName object | null | array | boolean | integer | number | string

Shipping full name

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
shippingLastName string | null

Shipping last name
shippingName string | null

Shipping name
shippingRateError string | null

Shipping rate error

Values are value or weight.
shippingState string | null

Shipping state
shippingZip string | null

Shipping zip
splitTag string | null

Split tag
stateTaxLocation string | null

State tax location
stateTaxRate number(float) | null

State tax rate
subtotal number Required

Subtotal

Default value is 0.
tags array[string] | null

Tags
tax number Required

Tax

Default value is 0.
taxCalculation string | null Required

Tax calculation

Values are default or custom. Default value is default.
taxIncluded boolean Required

Tax included

Default value is false.
taxShipping boolean | null Required

Tax shipping

Default value is true.
total number Required

Total

Default value is 0.
userId integer(int32) | null

User
vendorEndpointFormat string | null

Vendor endpoint format

Values are json, xml, csv, text, email, website, or phone.
vendorEndpointHeaders object | null | array | boolean | integer | number | string

Vendor endpoint headers

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
vendorEndpointResponse string | null

Vendor endpoint response
vendorId integer(int32) | null

Vendor
vendorReceivedId string | null

Vendor received
vendorReceivedReference string | null

Vendor received reference
vendorReceivedStatus string | null Required

Vendor received status

Values are notSent, received, or error. Default value is notSent.
vendorReceivedStatusReason string | null Required

Vendor received status reason

Values are sent, shipped, or cancelled. Default value is sent.
vendorReference string | null

Vendor reference
warehouseId integer(int32) | null

Warehouse
weight number(float) | null Required

Weight

Default value is 0.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- adjustmentReasonId integer(int32) | null
  
  Adjustment reason
- adminNotes string | null
  
  Admin notes
- approved boolean Required
  
  Approved
  
  Default value is true.
- billingAddressLineOne string | null
  
  Billing address line one
- billingAddressLineTwo string | null
  
  Billing address line two
- billingAddressMessage string | null
  
  Billing address message
- billingCity string | null
  
  Billing city
- billingCountry string | null
  
  Billing country
- billingFirstName string | null
  
  Billing first name
- billingFullName object | null | array | boolean | integer | number | string
  
  Billing full name
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- billingLastName string | null
  
  Billing last name
- billingName string | null
  
  Billing name
- billingState string | null
  
  Billing state
- billingZip string | null
  
  Billing zip
- cancellationStatus string Required
  
  Cancellation status
  
  Values are none, partial, or full. Default value is none.
- cancelled boolean Required
  
  Cancelled
  
  Default value is false.
- cancelledAt string(date-time) | null
  
  Cancelled at
- cityTaxLocation string | null
  
  City tax location
- cityTaxRate number(float) | null
  
  City tax rate
- combinedTaxRate number(float) | null
  
  Combined tax rate
- countyTaxLocation string | null
  
  County tax location
- countyTaxRate number(float) | null
  
  County tax rate
- createdAt string(date-time)
  
  Created at
- customerReference string | null
  
  Customer reference
- dateOrdered string(date-time) Required
  
  Date ordered
  
  Default value is {} (empty).
- deliveryExpectedAt string(date-time) | null
  
  Delivery expected at
- discounts number Required
  
  Discounts
  
  Default value is 0.
- districtTaxRate number(float) | null
  
  District tax rate
- dropshipNotes string | null
  
  Dropship notes
- dropshipProviderAddressId integer(int32) | null
  
  Dropship provider address
- dropshipProviderId integer(int32) | null
  
  Dropship provider
- files object | null | array | boolean | integer | number | string
  
  Files
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- finalized boolean Required
  
  Finalized
  
  Default value is true.
- id integer(int32)
  
  Id
- intercomMessageId string | null
  
  Intercom message
- internalReference string | null
  
  Internal reference
- invalidBillingAddress string | null
  
  Invalid billing address
- invalidShippingAddress boolean | null Required
  
  Invalid shipping address
  
  Default value is false.
- inventoryStatus string Required
  
  Inventory status
  
  Values are notReceived, partiallyReceived, or received. Default value is notReceived.
- invoiceProblem object | null | array | boolean | integer | number | string
  
  Invoice problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- invoiceStatus string Required
  
  Invoice status
  
  Values are notInvoiced, partiallyInvoiced, or invoiced. Default value is notInvoiced.
- isDropship boolean Required
  
  Is dropship
- labelProblem object | null | array | boolean | integer | number | string
  
  Label problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- lastDropshipmentReference integer(int32) | null Required
  
  Last dropshipment reference
  
  Default value is 0.
- lastGoodsReceiptReference integer(int32) | null Required
  
  Last goods receipt reference
  
  Default value is 0.
- lastPurchaseInvoiceReference integer(int32) | null Required
  
  Last purchase invoice reference
  
  Default value is 0.
- locked boolean Required
  
  Locked
  
  Default value is false.
- muteError boolean | null Required
  
  Mute error
  
  Default value is false.
- notes string | null
  
  Notes
- orderProblem object | null | array | boolean | integer | number | string
  
  Order problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- orderSplitting string | null Required
  
  Order splitting
  
  Values are group, splitTag, splitQuantity, or externalLocationId. Default value is group.
- orderSplittingKey string | null
  
  Order splitting key
- pauseProblems object | null | array | boolean | integer | number | string
  
  Pause problems
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- paymentExpectedAt string(date-time) | null
  
  Payment expected at
- paymentStatus string Required
  
  Payment status
  
  Values are notPaid, partiallyPaid, or paid. Default value is notPaid.
- priceListId integer(int32) | null
  
  Price list
- purchaseId integer(int32) | null
  
  Purchase
- purchaseImportExternalId string | null
  
  Purchase import external
- purchaseStatusId integer(int32) | null
  
  Purchase status
- purchaseType string Required
  
  Purchase type
  
  Values are replenishment, dropship, automated_dropship, automated_replenishment, or adjusted_dropship. Default value is replenishment.
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 0.
- receiverAddressLineOne string | null
  
  Receiver address line one
- receiverAddressLineTwo string | null
  
  Receiver address line two
- receiverCity string | null
  
  Receiver city
- receiverCountry string | null
  
  Receiver country
- receiverName string | null
  
  Receiver name
- receiverState string | null
  
  Receiver state
- receiverZip string | null
  
  Receiver zip
- reference string Required
  
  Reference
- reminderLastSent string(date-time) | null
  
  Reminder last sent
- reminderSent integer(int32) | null Required
  
  Reminder sent
  
  Default value is false.
- returnLabelProblem object | null | array | boolean | integer | number | string
  
  Return label problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- returnStatus string Required
  
  Return status
  
  Values are notReturned, partiallyReturned, or returned. Default value is notReturned.
- saleId integer(int32) | null
  
  Sale
- sendSource string | null
  
  Send source
  
  Values are manual or automatic.
- shipmentRouting string | null Required
  
  Shipment routing
  
  Values are customer, consolidated, or consolidatedInternational. Default value is customer.
- shippingAddressLineOne string | null
  
  Shipping address line one
- shippingAddressLineTwo string | null
  
  Shipping address line two
- shippingAddressMessage boolean | null Required
  
  Shipping address message
  
  Default value is false.
- shippingCity string | null
  
  Shipping city
- shippingCountry string | null
  
  Shipping country
- shippingExpectedAt string(date-time) | null
  
  Shipping expected at
- shippingFirstName string | null
  
  Shipping first name
- shippingFullName object | null | array | boolean | integer | number | string
  
  Shipping full name
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- shippingLastName string | null
  
  Shipping last name
- shippingName string | null
  
  Shipping name
- shippingRateError string | null
  
  Shipping rate error
  
  Values are value or weight.
- shippingState string | null
  
  Shipping state
- shippingZip string | null
  
  Shipping zip
- splitTag string | null
  
  Split tag
- stateTaxLocation string | null
  
  State tax location
- stateTaxRate number(float) | null
  
  State tax rate
- subtotal number Required
  
  Subtotal
  
  Default value is 0.
- tags array[string] | null
  
  Tags
- tax number Required
  
  Tax
  
  Default value is 0.
- taxCalculation string | null Required
  
  Tax calculation
  
  Values are default or custom. Default value is default.
- taxIncluded boolean Required
  
  Tax included
  
  Default value is false.
- taxShipping boolean | null Required
  
  Tax shipping
  
  Default value is true.
- total number Required
  
  Total
  
  Default value is 0.
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- vendorEndpointFormat string | null
  
  Vendor endpoint format
  
  Values are json, xml, csv, text, email, website, or phone.
- vendorEndpointHeaders object | null | array | boolean | integer | number | string
  
  Vendor endpoint headers
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- vendorEndpointResponse string | null
  
  Vendor endpoint response
- vendorId integer(int32) | null
  
  Vendor
- vendorReceivedId string | null
  
  Vendor received
- vendorReceivedReference string | null
  
  Vendor received reference
- vendorReceivedStatus string | null Required
  
  Vendor received status
  
  Values are notSent, received, or error. Default value is notSent.
- vendorReceivedStatusReason string | null Required
  
  Vendor received status reason
  
  Values are sent, shipped, or cancelled. Default value is sent.
- vendorReference string | null
  
  Vendor reference
- warehouseId integer(int32) | null
  
  Warehouse
- weight number(float) | null Required
  
  Weight
  
  Default value is 0.

POST /purchases.json

curl \
 --request POST 'http://api.example.com/v1/purchases.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"adjustmentReasonId":42,"adminNotes":"string","approved":true,"billingAddressLineOne":"string","billingAddressLineTwo":"string","billingAddressMessage":"string","billingCity":"string","billingCountry":"string","billingFirstName":"string","billingFullName":{},"billingLastName":"string","billingName":"string","billingState":"string","billingZip":"string","cancellationStatus":"none","cancelled":false,"cancelledAt":"2025-05-04T09:42:00Z","cityTaxLocation":"string","cityTaxRate":42.0,"combinedTaxRate":42.0,"countyTaxLocation":"string","countyTaxRate":42.0,"customerReference":"string","dateOrdered":{},"deliveryExpectedAt":"2025-05-04T09:42:00Z","discounts":0,"districtTaxRate":42.0,"dropshipNotes":"string","dropshipProviderAddressId":42,"dropshipProviderId":42,"files":{},"finalized":true,"intercomMessageId":"string","internalReference":"string","invalidBillingAddress":"string","invalidShippingAddress":false,"inventoryStatus":"notReceived","invoiceProblem":{},"invoiceStatus":"notInvoiced","isDropship":true,"labelProblem":{},"lastDropshipmentReference":0,"lastGoodsReceiptReference":0,"lastPurchaseInvoiceReference":0,"locked":false,"muteError":false,"notes":"string","orderProblem":{},"orderSplitting":"group","orderSplittingKey":"string","pauseProblems":{},"paymentExpectedAt":"2025-05-04T09:42:00Z","paymentStatus":"notPaid","priceListId":42,"purchaseId":42,"purchaseImportExternalId":"string","purchaseStatusId":42,"purchaseType":"replenishment","quantity":0,"receiverAddressLineOne":"string","receiverAddressLineTwo":"string","receiverCity":"string","receiverCountry":"string","receiverName":"string","receiverState":"string","receiverZip":"string","reference":"string","reminderLastSent":"2025-05-04T09:42:00Z","reminderSent":false,"returnLabelProblem":{},"returnStatus":"notReturned","saleId":42,"sendSource":"manual","shipmentRouting":"customer","shippingAddressLineOne":"string","shippingAddressLineTwo":"string","shippingAddressMessage":false,"shippingCity":"string","shippingCountry":"string","shippingExpectedAt":"2025-05-04T09:42:00Z","shippingFirstName":"string","shippingFullName":{},"shippingLastName":"string","shippingName":"string","shippingRateError":"value","shippingState":"string","shippingZip":"string","splitTag":"string","stateTaxLocation":"string","stateTaxRate":42.0,"subtotal":0,"tags":["string"],"tax":0,"taxCalculation":"default","taxIncluded":false,"taxShipping":true,"total":0,"userId":42,"vendorEndpointFormat":"json","vendorEndpointHeaders":{},"vendorEndpointResponse":"string","vendorId":42,"vendorReceivedId":"string","vendorReceivedReference":"string","vendorReceivedStatus":"notSent","vendorReceivedStatusReason":"sent","vendorReference":"string","warehouseId":42,"weight":0}'

Request examples

{
  "adjustmentReasonId": 42,
  "adminNotes": "string",
  "approved": true,
  "billingAddressLineOne": "string",
  "billingAddressLineTwo": "string",
  "billingAddressMessage": "string",
  "billingCity": "string",
  "billingCountry": "string",
  "billingFirstName": "string",
  "billingFullName": {},
  "billingLastName": "string",
  "billingName": "string",
  "billingState": "string",
  "billingZip": "string",
  "cancellationStatus": "none",
  "cancelled": false,
  "cancelledAt": "2025-05-04T09:42:00Z",
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "combinedTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "customerReference": "string",
  "dateOrdered": {},
  "deliveryExpectedAt": "2025-05-04T09:42:00Z",
  "discounts": 0,
  "districtTaxRate": 42.0,
  "dropshipNotes": "string",
  "dropshipProviderAddressId": 42,
  "dropshipProviderId": 42,
  "files": {},
  "finalized": true,
  "intercomMessageId": "string",
  "internalReference": "string",
  "invalidBillingAddress": "string",
  "invalidShippingAddress": false,
  "inventoryStatus": "notReceived",
  "invoiceProblem": {},
  "invoiceStatus": "notInvoiced",
  "isDropship": true,
  "labelProblem": {},
  "lastDropshipmentReference": 0,
  "lastGoodsReceiptReference": 0,
  "lastPurchaseInvoiceReference": 0,
  "locked": false,
  "muteError": false,
  "notes": "string",
  "orderProblem": {},
  "orderSplitting": "group",
  "orderSplittingKey": "string",
  "pauseProblems": {},
  "paymentExpectedAt": "2025-05-04T09:42:00Z",
  "paymentStatus": "notPaid",
  "priceListId": 42,
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "purchaseStatusId": 42,
  "purchaseType": "replenishment",
  "quantity": 0,
  "receiverAddressLineOne": "string",
  "receiverAddressLineTwo": "string",
  "receiverCity": "string",
  "receiverCountry": "string",
  "receiverName": "string",
  "receiverState": "string",
  "receiverZip": "string",
  "reference": "string",
  "reminderLastSent": "2025-05-04T09:42:00Z",
  "reminderSent": false,
  "returnLabelProblem": {},
  "returnStatus": "notReturned",
  "saleId": 42,
  "sendSource": "manual",
  "shipmentRouting": "customer",
  "shippingAddressLineOne": "string",
  "shippingAddressLineTwo": "string",
  "shippingAddressMessage": false,
  "shippingCity": "string",
  "shippingCountry": "string",
  "shippingExpectedAt": "2025-05-04T09:42:00Z",
  "shippingFirstName": "string",
  "shippingFullName": {},
  "shippingLastName": "string",
  "shippingName": "string",
  "shippingRateError": "value",
  "shippingState": "string",
  "shippingZip": "string",
  "splitTag": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "subtotal": 0,
  "tags": [
    "string"
  ],
  "tax": 0,
  "taxCalculation": "default",
  "taxIncluded": false,
  "taxShipping": true,
  "total": 0,
  "userId": 42,
  "vendorEndpointFormat": "json",
  "vendorEndpointHeaders": {},
  "vendorEndpointResponse": "string",
  "vendorId": 42,
  "vendorReceivedId": "string",
  "vendorReceivedReference": "string",
  "vendorReceivedStatus": "notSent",
  "vendorReceivedStatusReason": "sent",
  "vendorReference": "string",
  "warehouseId": 42,
  "weight": 0
}

Response examples (200)

{
  "adjustmentReasonId": 42,
  "adminNotes": "string",
  "approved": true,
  "billingAddressLineOne": "string",
  "billingAddressLineTwo": "string",
  "billingAddressMessage": "string",
  "billingCity": "string",
  "billingCountry": "string",
  "billingFirstName": "string",
  "billingFullName": {},
  "billingLastName": "string",
  "billingName": "string",
  "billingState": "string",
  "billingZip": "string",
  "cancellationStatus": "none",
  "cancelled": false,
  "cancelledAt": "2025-05-04T09:42:00Z",
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "combinedTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "createdAt": "2025-05-04T09:42:00Z",
  "customerReference": "string",
  "dateOrdered": {},
  "deliveryExpectedAt": "2025-05-04T09:42:00Z",
  "discounts": 0,
  "districtTaxRate": 42.0,
  "dropshipNotes": "string",
  "dropshipProviderAddressId": 42,
  "dropshipProviderId": 42,
  "files": {},
  "finalized": true,
  "id": 42,
  "intercomMessageId": "string",
  "internalReference": "string",
  "invalidBillingAddress": "string",
  "invalidShippingAddress": false,
  "inventoryStatus": "notReceived",
  "invoiceProblem": {},
  "invoiceStatus": "notInvoiced",
  "isDropship": true,
  "labelProblem": {},
  "lastDropshipmentReference": 0,
  "lastGoodsReceiptReference": 0,
  "lastPurchaseInvoiceReference": 0,
  "locked": false,
  "muteError": false,
  "notes": "string",
  "orderProblem": {},
  "orderSplitting": "group",
  "orderSplittingKey": "string",
  "pauseProblems": {},
  "paymentExpectedAt": "2025-05-04T09:42:00Z",
  "paymentStatus": "notPaid",
  "priceListId": 42,
  "purchaseId": 42,
  "purchaseImportExternalId": "string",
  "purchaseStatusId": 42,
  "purchaseType": "replenishment",
  "quantity": 0,
  "receiverAddressLineOne": "string",
  "receiverAddressLineTwo": "string",
  "receiverCity": "string",
  "receiverCountry": "string",
  "receiverName": "string",
  "receiverState": "string",
  "receiverZip": "string",
  "reference": "string",
  "reminderLastSent": "2025-05-04T09:42:00Z",
  "reminderSent": false,
  "returnLabelProblem": {},
  "returnStatus": "notReturned",
  "saleId": 42,
  "sendSource": "manual",
  "shipmentRouting": "customer",
  "shippingAddressLineOne": "string",
  "shippingAddressLineTwo": "string",
  "shippingAddressMessage": false,
  "shippingCity": "string",
  "shippingCountry": "string",
  "shippingExpectedAt": "2025-05-04T09:42:00Z",
  "shippingFirstName": "string",
  "shippingFullName": {},
  "shippingLastName": "string",
  "shippingName": "string",
  "shippingRateError": "value",
  "shippingState": "string",
  "shippingZip": "string",
  "splitTag": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "subtotal": 0,
  "tags": [
    "string"
  ],
  "tax": 0,
  "taxCalculation": "default",
  "taxIncluded": false,
  "taxShipping": true,
  "total": 0,
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "vendorEndpointFormat": "json",
  "vendorEndpointHeaders": {},
  "vendorEndpointResponse": "string",
  "vendorId": 42,
  "vendorReceivedId": "string",
  "vendorReceivedReference": "string",
  "vendorReceivedStatus": "notSent",
  "vendorReceivedStatusReason": "sent",
  "vendorReference": "string",
  "warehouseId": 42,
  "weight": 0
}

GET /purchase-invoice-items/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- purchaseInvoiceId integer(int32) Required
  
  Purchase invoice
- purchaseItemId integer(int32) Required
  
  Purchase item
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 0.
- updatedAt string(date-time)
  
  Updated at

GET /purchase-invoice-items/{id}.json

curl \
 --request GET 'http://api.example.com/v1/purchase-invoice-items/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "purchaseInvoiceId": 42,
  "purchaseItemId": 42,
  "quantity": 0,
  "updatedAt": "2025-05-04T09:42:00Z"
}

PUT /reseller-subscriptions/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

createdAt string(date-time)

Created at
discount object | null | array | boolean | integer | number | string

Discount

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
id integer(int32)

Id
name string | null

Name
resellerId integer(int32) Required

Reseller
status string | null Required

Status

Values are pending, active, error, lapsed, declined, or cancelled. Default value is pending.
stripeProductId string | null

Stripe product
stripeSubscriptionId string | null

Stripe subscription
updatedAt string(date-time)

Updated at

PUT /reseller-subscriptions/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/reseller-subscriptions/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"createdAt":"2025-05-04T09:42:00Z","discount":{},"id":42,"name":"string","resellerId":42,"status":"pending","stripeProductId":"string","stripeSubscriptionId":"string","updatedAt":"2025-05-04T09:42:00Z"}'

Request examples

{
  "createdAt": "2025-05-04T09:42:00Z",
  "discount": {},
  "id": 42,
  "name": "string",
  "resellerId": 42,
  "status": "pending",
  "stripeProductId": "string",
  "stripeSubscriptionId": "string",
  "updatedAt": "2025-05-04T09:42:00Z"
}

GET /subscription-charges/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- charged integer(int32) | null
  
  Charged
- chargedAt string(date-time) Required
  
  Charged at
- createdAt string(date-time)
  
  Created at
- externalId string | null
  
  External
- id integer(int32)
  
  Id
- subscriptionId integer(int32) Required
  
  Subscription
- updatedAt string(date-time)
  
  Updated at

GET /subscription-charges/{id}.json

curl \
 --request GET 'http://api.example.com/v1/subscription-charges/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "charged": 42,
  "chargedAt": "2025-05-04T09:42:00Z",
  "createdAt": "2025-05-04T09:42:00Z",
  "externalId": "string",
  "id": 42,
  "subscriptionId": 42,
  "updatedAt": "2025-05-04T09:42:00Z"
}

GET /variant-warehouse-updates/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- adjustments integer(int32) | null
  
  Adjustments
- available integer(int32) | null
  
  Available
- createdAt string(date-time)
  
  Created at
- dropshipmentItems integer(int32) | null
  
  Dropshipment items
- id integer(int32)
  
  Id
- inventoryAllocated integer(int32) | null
  
  Inventory allocated
- inventoryQuantity integer(int32) | null
  
  Inventory quantity
- received integer(int32) | null
  
  Received
- shipped integer(int32) | null
  
  Shipped
- sold integer(int32) | null
  
  Sold
- totalIn integer(int32) | null
  
  Total in
- totalOut integer(int32) | null
  
  Total out
- transfersIn integer(int32) | null
  
  Transfers in
- transfersOut integer(int32) | null
  
  Transfers out
- updatedAt string(date-time)
  
  Updated at
- variantInventoryUpdateId integer(int32) Required
  
  Variant inventory update
- warehouseId integer(int32) Required
  
  Warehouse

GET /variant-warehouse-updates/{id}.json

curl \
 --request GET 'http://api.example.com/v1/variant-warehouse-updates/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "adjustments": 42,
  "available": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipmentItems": 42,
  "id": 42,
  "inventoryAllocated": 42,
  "inventoryQuantity": 42,
  "received": 42,
  "shipped": 42,
  "sold": 42,
  "totalIn": 42,
  "totalOut": 42,
  "transfersIn": 42,
  "transfersOut": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "variantInventoryUpdateId": 42,
  "warehouseId": 42
}

Body Required

address-validation Dismiss highlight

Body Required

Body Required

billingFullName object | null | array | boolean | integer | number | string

files object | null | array | boolean | integer | number | string

invoiceProblem object | null | array | boolean | integer | number | string

labelProblem object | null | array | boolean | integer | number | string

orderProblem object | null | array | boolean | integer | number | string

pauseProblems object | null | array | boolean | integer | number | string

returnLabelProblem object | null | array | boolean | integer | number | string

shippingFullName object | null | array | boolean | integer | number | string

vendorEndpointHeaders object | null | array | boolean | integer | number | string

billingFullName object | null | array | boolean | integer | number | string

files object | null | array | boolean | integer | number | string

invoiceProblem object | null | array | boolean | integer | number | string

labelProblem object | null | array | boolean | integer | number | string

orderProblem object | null | array | boolean | integer | number | string

pauseProblems object | null | array | boolean | integer | number | string

returnLabelProblem object | null | array | boolean | integer | number | string

shippingFullName object | null | array | boolean | integer | number | string

vendorEndpointHeaders object | null | array | boolean | integer | number | string

Body Required

discount object | null | array | boolean | integer | number | string