POST /address-validations.json

POST /address-validations.json
application/json

Body Required

Responses

POST /address-validations.json
curl \
 -X POST http://api.example.com/v1/address-validations.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"channelId":42,"payload":{},"response":{},"saleId":42,"source":"other"}'
Request example
{
  "channelId": 42,
  "payload": {},
  "response": {},
  "saleId": 42,
  "source": "other"
}
Response examples (200)
{
  "channelId": 42,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "response": {},
  "saleId": 42,
  "source": "other",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}




























POST /adjustment-reasons.json

POST /adjustment-reasons.json
application/json

Body Required

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
POST /adjustment-reasons.json
curl \
 -X POST http://api.example.com/v1/adjustment-reasons.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"code":"string","name":"string","showInReturnsPortal":true}'
Request example
{
  "code": "string",
  "name": "string",
  "showInReturnsPortal": true
}
Response examples (200)
{
  "code": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2024-05-04T09:42:00+00:00"
}
































GET /allowed-tags/{id}.json

GET /allowed-tags/{id}.json

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

    • resource string Required

      Resource

      Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.

    • tag string Required

      Tag

    • updatedAt string(date-time)

      Updated at

GET /allowed-tags/{id}.json
curl \
 -X GET http://api.example.com/v1/allowed-tags/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}




















































































DELETE /carriers/{id}.json

DELETE /carriers/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

DELETE /carriers/{id}.json
curl \
 -X DELETE http://api.example.com/v1/carriers/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"




























































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































PUT /inventory-feed-mappings/{id}.json

PUT /inventory-feed-mappings/{id}.json

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

  • field string Required

    Field

    Values are optionName, optionValue, metaFieldName, or metaFieldValue.

  • id integer(int32)

    Id

  • inventoryFeedId integer(int32) | null

    Inventory feed

  • matchType string Required

    Match type

    Values are includes, excludes, matches, startsWith, or endsWith.

  • transformFrom array[string] Required

    Transform from

  • transformTo string Required

    Transform to

  • transformType string Required

    Transform type

    Values are capitalize, humanize, or none. Default value is none.

  • updatedAt string(date-time)

    Updated at

PUT /inventory-feed-mappings/{id}.json
curl \
 -X PUT http://api.example.com/v1/inventory-feed-mappings/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"createdAt":"2024-05-04T09:42:00+00:00","field":"optionName","id":42,"inventoryFeedId":42,"matchType":"includes","transformFrom":["string"],"transformTo":"string","transformType":"none","updatedAt":"2024-05-04T09:42:00+00:00"}'
Request example
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "field": "optionName",
  "id": 42,
  "inventoryFeedId": 42,
  "matchType": "includes",
  "transformFrom": [
    "string"
  ],
  "transformTo": "string",
  "transformType": "none",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}




























































































































































GET /inventory-transfer-items/{id}.json

GET /inventory-transfer-items/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /inventory-transfer-items/{id}.json
curl \
 -X GET http://api.example.com/v1/inventory-transfer-items/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "adjustmentReasonId": 42,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "id": 42,
  "inventoryTransferId": 42,
  "quantity": 1,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "variantId": 42
}












































GET /landed-cost-dropship-providers/{id}.json

GET /landed-cost-dropship-providers/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /landed-cost-dropship-providers/{id}.json
curl \
 -X GET http://api.example.com/v1/landed-cost-dropship-providers/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "id": 42,
  "landedCostId": 42,
  "updatedAt": "2024-05-04T09:42:00+00:00"
}




















































































































































































































































































































































































































































































GET /referrals/{id}.json

GET /referrals/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /referrals/{id}.json
curl \
 -X GET http://api.example.com/v1/referrals/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "about": "string",
  "addressLineOne": "string",
  "addressLineTwo": "string",
  "authenticationSecret": "string",
  "authenticationToken": "string",
  "city": "string",
  "commissionRate": 42.0,
  "country": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "email": "string",
  "id": 42,
  "iso": "string",
  "logo": "string",
  "name": "string",
  "orderEndpointUrl": "string",
  "phone": "string",
  "platform": "wooCommerce",
  "referralCode": "string",
  "returnsPolicy": "string",
  "shopifyStoreId": 42,
  "sourceType": "channel",
  "state": "string",
  "stripeId": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "welcomeMessage": "string",
  "wooCommerceStoreId": 42,
  "zip": "string"
}




























































































GET /review-reasons/{id}.json

GET /review-reasons/{id}.json

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

    • name string Required

      Name

    • reviewType string | null Required

      Review type

      Values are approve or reject. Default value is approve.

    • updatedAt string(date-time)

      Updated at

GET /review-reasons/{id}.json
curl \
 -X GET http://api.example.com/v1/review-reasons/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "reviewType": "approve",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}
















PUT /sales/{id}.json

PUT /sales/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

PUT /sales/{id}.json
curl \
 -X PUT http://api.example.com/v1/sales/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"adjustmentReasonId":42,"adminNotes":"string","billingAddressLineOne":"string","billingAddressLineTwo":"string","billingAddressMessage":"string","billingCity":"string","billingCountry":"string","billingFirstName":"string","billingFullName":{},"billingLastName":"string","billingName":"string","billingState":"string","billingZip":"string","cancelReason":"customer","cancellationStatus":"none","cancelled":false,"cancelledAt":"2024-05-04T09:42:00+00:00","channelCancelledAt":"2024-05-04T09:42:00+00:00","channelId":42,"cityTaxLocation":"string","cityTaxRate":42.0,"cloneReason":"exchange","combinedTaxRate":42.0,"countyTaxLocation":"string","countyTaxRate":42.0,"createdAt":"2024-05-04T09:42:00+00:00","currencyId":42,"customerId":42,"customerReference":"string","dateOrdered":{},"discounts":0,"districtTaxRate":42.0,"dropshipProblems":{},"exchangeRate":42.0,"externalChannelSiteId":"string","externalId":"string","finalized":true,"id":42,"intercomMessageId":"string","internalNotes":"string","invalidBillingAddress":"string","invalidShippingAddress":false,"inventoryStatus":"notFulfilled","invoiceStatus":"notInvoiced","iso":"string","lastFulfillmentReference":0,"lastPurchaseReference":0,"lastSaleReturnReference":0,"locked":false,"muteError":false,"notes":"string","paid":42.0,"paymentProviderIds":[],"paymentStatus":"notPaid","priceListId":42,"quantity":0,"receiverAddressLineOne":"string","receiverAddressLineTwo":"string","receiverCity":"string","receiverCountry":"string","receiverName":"string","receiverState":"string","receiverZip":"string","reference":"string","resellerId":42,"resellerPayee":"reseller","resellerStripeChargeId":"string","returnStatus":"notReturned","saleDiscountCodeId":42,"saleId":42,"saleReturnProblems":{},"shippingAddressLineOne":"string","shippingAddressLineTwo":"string","shippingAddressMessage":false,"shippingCity":"string","shippingCountry":"string","shippingFirstName":"string","shippingFullName":{},"shippingLastName":"string","shippingName":"string","shippingState":"string","shippingZip":"string","shipstationId":"string","stateTaxLocation":"string","stateTaxRate":42.0,"status":"pending","subtotal":0,"tags":["string"],"tax":0,"taxCalculation":"default","taxIncluded":false,"taxShipping":true,"total":0,"updatedAt":"2024-05-04T09:42:00+00:00","userId":42,"warehouseId":42,"weight":0}'
Request example
{
  "adjustmentReasonId": 42,
  "adminNotes": "string",
  "billingAddressLineOne": "string",
  "billingAddressLineTwo": "string",
  "billingAddressMessage": "string",
  "billingCity": "string",
  "billingCountry": "string",
  "billingFirstName": "string",
  "billingFullName": {},
  "billingLastName": "string",
  "billingName": "string",
  "billingState": "string",
  "billingZip": "string",
  "cancelReason": "customer",
  "cancellationStatus": "none",
  "cancelled": false,
  "cancelledAt": "2024-05-04T09:42:00+00:00",
  "channelCancelledAt": "2024-05-04T09:42:00+00:00",
  "channelId": 42,
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "cloneReason": "exchange",
  "combinedTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "currencyId": 42,
  "customerId": 42,
  "customerReference": "string",
  "dateOrdered": {},
  "discounts": 0,
  "districtTaxRate": 42.0,
  "dropshipProblems": {},
  "exchangeRate": 42.0,
  "externalChannelSiteId": "string",
  "externalId": "string",
  "finalized": true,
  "id": 42,
  "intercomMessageId": "string",
  "internalNotes": "string",
  "invalidBillingAddress": "string",
  "invalidShippingAddress": false,
  "inventoryStatus": "notFulfilled",
  "invoiceStatus": "notInvoiced",
  "iso": "string",
  "lastFulfillmentReference": 0,
  "lastPurchaseReference": 0,
  "lastSaleReturnReference": 0,
  "locked": false,
  "muteError": false,
  "notes": "string",
  "paid": 42.0,
  "paymentProviderIds": [],
  "paymentStatus": "notPaid",
  "priceListId": 42,
  "quantity": 0,
  "receiverAddressLineOne": "string",
  "receiverAddressLineTwo": "string",
  "receiverCity": "string",
  "receiverCountry": "string",
  "receiverName": "string",
  "receiverState": "string",
  "receiverZip": "string",
  "reference": "string",
  "resellerId": 42,
  "resellerPayee": "reseller",
  "resellerStripeChargeId": "string",
  "returnStatus": "notReturned",
  "saleDiscountCodeId": 42,
  "saleId": 42,
  "saleReturnProblems": {},
  "shippingAddressLineOne": "string",
  "shippingAddressLineTwo": "string",
  "shippingAddressMessage": false,
  "shippingCity": "string",
  "shippingCountry": "string",
  "shippingFirstName": "string",
  "shippingFullName": {},
  "shippingLastName": "string",
  "shippingName": "string",
  "shippingState": "string",
  "shippingZip": "string",
  "shipstationId": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "status": "pending",
  "subtotal": 0,
  "tags": [
    "string"
  ],
  "tax": 0,
  "taxCalculation": "default",
  "taxIncluded": false,
  "taxShipping": true,
  "total": 0,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "userId": 42,
  "warehouseId": 42,
  "weight": 0
}




































































































































































































































































































































































































DELETE /shipping-rate-zones/{id}.json

DELETE /shipping-rate-zones/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

DELETE /shipping-rate-zones/{id}.json
curl \
 -X DELETE http://api.example.com/v1/shipping-rate-zones/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
































































































































































POST /tax-rates.json

POST /tax-rates.json
application/json

Body Required

Responses

POST /tax-rates.json
curl \
 -X POST http://api.example.com/v1/tax-rates.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"cityTaxLocation":"string","cityTaxRate":42.0,"countyTaxLocation":"string","countyTaxRate":42.0,"districtTaxLocation":"string","districtTaxRate":42.0,"name":"string","stateTaxLocation":"string","stateTaxRate":42.0,"xeroId":"string"}'
Request example
{
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "districtTaxLocation": "string",
  "districtTaxRate": 42.0,
  "name": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "xeroId": "string"
}
Response examples (200)
{
  "cityTaxLocation": "string",
  "cityTaxRate": 42.0,
  "countyTaxLocation": "string",
  "countyTaxRate": 42.0,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "districtTaxLocation": "string",
  "districtTaxRate": 42.0,
  "id": 42,
  "name": "string",
  "stateTaxLocation": "string",
  "stateTaxRate": 42.0,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "xeroId": "string"
}








































DELETE /template-mappings/{id}.json

DELETE /template-mappings/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

DELETE /template-mappings/{id}.json
curl \
 -X DELETE http://api.example.com/v1/template-mappings/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"












































































































GET /users/{id}.json

GET /users/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

GET /users/{id}.json
curl \
 -X GET http://api.example.com/v1/users/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "archiveReason": "other",
  "channel": {},
  "closedConversations": 0,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "credentialCycles": 0,
  "customerId": 42,
  "dropDescription": "string",
  "dropReason": "old",
  "droppedAt": "2024-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "email": "string",
  "emailExport": true,
  "emailSet": true,
  "enabled": true,
  "firstName": "string",
  "fullName": {},
  "hasUnviewedAnnouncements": false,
  "hash": {},
  "id": 42,
  "initials": {},
  "invitationStatus": "notSent",
  "invoicingNotifications": true,
  "lastName": "string",
  "limitConsumption": 42,
  "openConversations": 0,
  "partnerId": 42,
  "password": "string",
  "passwordSet": true,
  "profileImage": "string",
  "resellerId": 42,
  "resetToken": "string",
  "role": "admin",
  "shippingNotifications": true,
  "throttle": true,
  "throttleParity": true,
  "token": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "vendorId": 42
}