API docs by Redocly

Orders API (3.1.1)

Download OpenAPI specification:Download

Responsible for managing invoices and sales orders

Invoice

Creates an invoice

Authorizations:
None
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
userId
required
string
createdByCrmId
string
orderId
required
string
externalInvoiceId
string
description
string
totalAmount
required
integer
totalTaxAmount
required
integer
subtotalAmount
required
integer
shippingAddress1
string
shippingAddress2
string
shippingCity
string
shippingState
string
shippingPostalCode
string
shippingCountry
string
shippingType
string
Enum: "standard" "2-day" "overnight" "local_pickup"
invoiceableType
required
string
Enum: "product" "membership" "ccm"
Array of objects (create-2)
channel
string
Enum: "Subscriptions" "Store" "Training" "Protector Academy" "SOS" "ADMIN" "WOW" "Expo" "Events" "Lobby" "Store in a Store"

Responses

Request samples

Content type
application/json
{
  • "userId": "66677c2e-3dd3-11ed-ace5-02420a00013d",
  • "createdByCrmId": "01K000001dC8sBIAT",
  • "orderId": "1234567r",
  • "externalInvoiceId": "1000041",
  • "description": "Invoice description",
  • "totalAmount": "100.50",
  • "totalTaxAmount": "111.00",
  • "subtotalAmount": "10.50",
  • "shippingAddress1": "1000 Freedom Way",
  • "shippingAddress2": "",
  • "shippingCity": "West Bend",
  • "shippingState": "WI",
  • "shippingPostalCode": "53095",
  • "shippingCountry": "US",
  • "shippingType": "standard",
  • "invoiceableType": "product",
  • "items": [
    ],
  • "channel": "Store"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves an invoice

Authorizations:
None
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates an invoice

Authorizations:
None
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
salesOrderId
string
object

Responses

Request samples

Content type
application/json
{
  • "salesOrderId": "cf740d58-938d-11ed-a7d6-0242ac120008",
  • "carrier": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a sales order for an invoice

Authorizations:
None
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
externalId
string
object
isProcessed
boolean
errorMessage
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

User

Retrieves a User's invoices

Authorizations:
None
path Parameters
user-id
required
string
Example: 66677c2e-3dd3-11ed-ace5-02420a00013d
query Parameters
page
integer
Example: page=1
perPage
integer
Example: perPage=25
sort
string
Example: sort=desc
sortBy
string
Example: sortBy=createdAt
invoiceableType
string
Example: invoiceableType=product
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Retrieves a User's sales orders

Authorizations:
None
path Parameters
user-id
required
string
Example: 66677c2e-3dd3-11ed-ace5-02420a00013d
query Parameters
page
integer
Example: page=1
perPage
integer
Example: perPage=25
sort
string
Example: sort=desc
sortBy
string
Example: sortBy=createdAt
channel
string
Example: channel=Subscriptions
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Zuora

Retrieves invoices for a Zuora account

Authorizations:
None
path Parameters
account-id
required
string
Example: 8ac6932381859c1101819235c77f6c4c
query Parameters
page
integer
Example: page=1
perPage
integer
Example: perPage=25
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieves a pdf invoice

Authorizations:
None
path Parameters
zuora-invoice-id
required
string
Example: 8ad093f27ba11a13017ba6fe001e7092
zuora-file-id
required
string
Example: 8ad085ae7ba10e3a017ba6fe0361321d
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Sales Order

Retrieves a sales order for an invoice

Authorizations:
None
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}