Thrivecart

Endpoints:

  • GET /v1/Organizations/:id/thrivecart
  • POST /v1/Organizations/:id/thrivecart
  • GET /v1/Organizations/:id/thrivecart/count
  • DELETE /v1/Thrivecart/:id
  • PATCH /v1/Thrivecart/:id
  • POST /v1/Thrivecart/:id/order
  • HEAD /v1/Thrivecart/:id/order
  • POST /v1/Thrivecart/:id/import

The Thrivecart object

Parameters

  • id string readonly

  • addTax boolean

    Should tax be added to items

  • addedTaxRateClassification string

    Classification of default tax to use for items that weren't related to saved items. Defaults to 'standard'

  • ignoreTestOrders boolean

    Ignore orders made in test mode

  • name string

    Name of store for user's own identification

  • active boolean

  • locale string

  • sendInvoiceAutomatically boolean

  • sendEstimateAutomatically boolean

  • issueInvoiceForBankPayment boolean

    Issue invoice instead of estimate for bank payment on order received

  • issueInvoiceOnComplete boolean

    Issue invoice on complete status instead of immediatelly on order created

  • businessPremiseId string

  • electronicDeviceId string

  • organizationId string

  • unitId string

  • warehouseId string

  • accountId string

    • Additional propertiesExpand all 
    
      {
  "addTax": true,
  "addedTaxRateClassification": "string",
  "ignoreTestOrders": true,
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "string",
  "unitId": "string",
  "warehouseId": "string",
  "accountId": "string",
  "custom": {},
  "deletedAt": "2022-04-20T10:10:30+00:00Z",
  "_isDeleted": false,
  "deletedId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z"
}

Find Thrivecarts

GET /v1/Organizations/:id/thrivecart

Parameters

Path

  • id string required

    Organization id

Query

  • filter string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart', {
  method: 'GET',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      [
  {
    "addTax": true,
    "addedTaxRateClassification": "string",
    "ignoreTestOrders": true,
    "name": "string",
    "active": true,
    "locale": "string",
    "sendInvoiceAutomatically": true,
    "sendEstimateAutomatically": true,
    "issueInvoiceForBankPayment": true,
    "issueInvoiceOnComplete": true,
    "businessPremiseId": "string",
    "electronicDeviceId": "string",
    "id": "string",
    "organizationId": "string",
    "unitId": "string",
    "warehouseId": "string",
    "accountId": "string",
    "custom": {},
    "deletedAt": "2022-04-20T10:10:30+00:00Z",
    "_isDeleted": false,
    "deletedId": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z"
  }
]

Create Thrivecart

POST /v1/Organizations/:id/thrivecart

Parameters

Path

  • id string required

    Organization id

Properties

  • name string required

    Name of store for user's own identification

  • active boolean required

    Default is: true

  • sendInvoiceAutomatically boolean required

    Default is: true

  • sendEstimateAutomatically boolean required

    Default is: true

  • addTax boolean optional

    Should tax be added to items

  • addedTaxRateClassification string optional

    Classification of default tax to use for items that weren't related to saved items. Defaults to 'standard'

  • ignoreTestOrders boolean optional

    Ignore orders made in test mode

  • locale string optional

  • issueInvoiceForBankPayment boolean optional

    Issue invoice instead of estimate for bank payment on order received

  • issueInvoiceOnComplete boolean optional

    Issue invoice on complete status instead of immediatelly on order created

  • businessPremiseId string optional

  • electronicDeviceId string optional

  • organizationId string optional

  • unitId string optional

  • warehouseId string optional

  • accountId string optional

    • Additional propertiesExpand all 
      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart', {
  method: 'POST',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    addTax: true,
    addedTaxRateClassification: 'string',
    ignoreTestOrders: true,
    name: 'string',
    active: true,
    locale: 'string',
    sendInvoiceAutomatically: true,
    sendEstimateAutomatically: true,
    issueInvoiceForBankPayment: true,
    issueInvoiceOnComplete: true,
    businessPremiseId: 'string',
    electronicDeviceId: 'string',
    organizationId: 'string',
    unitId: 'string',
    warehouseId: 'string',
    accountId: 'string',
    custom: {}
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X POST https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "addTax": true, \
    "addedTaxRateClassification": "string", \
    "ignoreTestOrders": true, \
    "name": "string", \
    "active": true, \
    "locale": "string", \
    "sendInvoiceAutomatically": true, \
    "sendEstimateAutomatically": true, \
    "issueInvoiceForBankPayment": true, \
    "issueInvoiceOnComplete": true, \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "organizationId": "string", \
    "unitId": "string", \
    "warehouseId": "string", \
    "accountId": "string", \
    "custom": {}
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'addTax': True,
  'addedTaxRateClassification': 'string',
  'ignoreTestOrders': True,
  'name': 'string',
  'active': True,
  'locale': 'string',
  'sendInvoiceAutomatically': True,
  'sendEstimateAutomatically': True,
  'issueInvoiceForBankPayment': True,
  'issueInvoiceOnComplete': True,
  'businessPremiseId': 'string',
  'electronicDeviceId': 'string',
  'organizationId': 'string',
  'unitId': 'string',
  'warehouseId': 'string',
  'accountId': 'string',
  'custom': {}
}
response = requests.post(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "addTax": true,
  "addedTaxRateClassification": "string",
  "ignoreTestOrders": true,
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "string",
  "unitId": "string",
  "warehouseId": "string",
  "accountId": "string",
  "custom": {},
  "deletedAt": "2022-04-20T10:10:30+00:00Z",
  "_isDeleted": false,
  "deletedId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z"
}

Count Thrivecarts

GET /v1/Organizations/:id/thrivecart/count

Parameters

Path

  • id string required

    Organization id

Query

  • where string optional

    Criteria to match model instances

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart/count', {
  method: 'GET',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart/count \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/thrivecart/count'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "count": 42
}

Delete Thrivecart

DELETE /v1/Thrivecart/:id

Parameters

Path

  • id string required

    Model id

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Thrivecart/{id}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X DELETE https://api.spaceinvoices.com/v1/Thrivecart/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Thrivecart/{id}'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "count": 1
}

Patch Thrivecart

PATCH /v1/Thrivecart/:id

Parameters

Path

  • id string required

    Thrivecart id

Properties

  • name string required

    Name of store for user's own identification

  • active boolean required

    Default is: true

  • sendInvoiceAutomatically boolean required

    Default is: true

  • sendEstimateAutomatically boolean required

    Default is: true

  • addTax boolean optional

    Should tax be added to items

  • addedTaxRateClassification string optional

    Classification of default tax to use for items that weren't related to saved items. Defaults to 'standard'

  • ignoreTestOrders boolean optional

    Ignore orders made in test mode

  • locale string optional

  • issueInvoiceForBankPayment boolean optional

    Issue invoice instead of estimate for bank payment on order received

  • issueInvoiceOnComplete boolean optional

    Issue invoice on complete status instead of immediatelly on order created

  • businessPremiseId string optional

  • electronicDeviceId string optional

  • organizationId string optional

  • unitId string optional

  • warehouseId string optional

  • accountId string optional

    • Additional propertiesExpand all 
      
        const response = await fetch('https://api.spaceinvoices.com/v1/Thrivecart/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    addTax: true,
    addedTaxRateClassification: 'string',
    ignoreTestOrders: true,
    name: 'string',
    active: true,
    locale: 'string',
    sendInvoiceAutomatically: true,
    sendEstimateAutomatically: true,
    issueInvoiceForBankPayment: true,
    issueInvoiceOnComplete: true,
    businessPremiseId: 'string',
    electronicDeviceId: 'string',
    organizationId: 'string',
    unitId: 'string',
    warehouseId: 'string',
    accountId: 'string',
    custom: {}
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X PATCH https://api.spaceinvoices.com/v1/Thrivecart/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "addTax": true, \
    "addedTaxRateClassification": "string", \
    "ignoreTestOrders": true, \
    "name": "string", \
    "active": true, \
    "locale": "string", \
    "sendInvoiceAutomatically": true, \
    "sendEstimateAutomatically": true, \
    "issueInvoiceForBankPayment": true, \
    "issueInvoiceOnComplete": true, \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "organizationId": "string", \
    "unitId": "string", \
    "warehouseId": "string", \
    "accountId": "string", \
    "custom": {}
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Thrivecart/{id}'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'addTax': True,
  'addedTaxRateClassification': 'string',
  'ignoreTestOrders': True,
  'name': 'string',
  'active': True,
  'locale': 'string',
  'sendInvoiceAutomatically': True,
  'sendEstimateAutomatically': True,
  'issueInvoiceForBankPayment': True,
  'issueInvoiceOnComplete': True,
  'businessPremiseId': 'string',
  'electronicDeviceId': 'string',
  'organizationId': 'string',
  'unitId': 'string',
  'warehouseId': 'string',
  'accountId': 'string',
  'custom': {}
}
response = requests.patch(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "addTax": true,
  "addedTaxRateClassification": "string",
  "ignoreTestOrders": true,
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "string",
  "unitId": "string",
  "warehouseId": "string",
  "accountId": "string",
  "custom": {},
  "deletedAt": "2022-04-20T10:10:30+00:00Z",
  "_isDeleted": false,
  "deletedId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z"
}

Create Thrivecart

POST /v1/Thrivecart/:id/order

Parameters

Path

  • id string required

    Thrivecart id

Properties

  • name string required

    Name of store for user's own identification

  • active boolean required

    Default is: true

  • sendInvoiceAutomatically boolean required

    Default is: true

  • sendEstimateAutomatically boolean required

    Default is: true

  • addTax boolean optional

    Should tax be added to items

  • addedTaxRateClassification string optional

    Classification of default tax to use for items that weren't related to saved items. Defaults to 'standard'

  • ignoreTestOrders boolean optional

    Ignore orders made in test mode

  • locale string optional

  • issueInvoiceForBankPayment boolean optional

    Issue invoice instead of estimate for bank payment on order received

  • issueInvoiceOnComplete boolean optional

    Issue invoice on complete status instead of immediatelly on order created

  • businessPremiseId string optional

  • electronicDeviceId string optional

  • organizationId string optional

  • unitId string optional

  • warehouseId string optional

  • accountId string optional

    • Additional propertiesExpand all 
      
        const response = await fetch('https://api.spaceinvoices.com/v1/Thrivecart/{id}/order', {
  method: 'POST',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    addTax: true,
    addedTaxRateClassification: 'string',
    ignoreTestOrders: true,
    name: 'string',
    active: true,
    locale: 'string',
    sendInvoiceAutomatically: true,
    sendEstimateAutomatically: true,
    issueInvoiceForBankPayment: true,
    issueInvoiceOnComplete: true,
    businessPremiseId: 'string',
    electronicDeviceId: 'string',
    organizationId: 'string',
    unitId: 'string',
    warehouseId: 'string',
    accountId: 'string',
    custom: {}
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X POST https://api.spaceinvoices.com/v1/Thrivecart/{id}/order \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "addTax": true, \
    "addedTaxRateClassification": "string", \
    "ignoreTestOrders": true, \
    "name": "string", \
    "active": true, \
    "locale": "string", \
    "sendInvoiceAutomatically": true, \
    "sendEstimateAutomatically": true, \
    "issueInvoiceForBankPayment": true, \
    "issueInvoiceOnComplete": true, \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "organizationId": "string", \
    "unitId": "string", \
    "warehouseId": "string", \
    "accountId": "string", \
    "custom": {}
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Thrivecart/{id}/order'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'addTax': True,
  'addedTaxRateClassification': 'string',
  'ignoreTestOrders': True,
  'name': 'string',
  'active': True,
  'locale': 'string',
  'sendInvoiceAutomatically': True,
  'sendEstimateAutomatically': True,
  'issueInvoiceForBankPayment': True,
  'issueInvoiceOnComplete': True,
  'businessPremiseId': 'string',
  'electronicDeviceId': 'string',
  'organizationId': 'string',
  'unitId': 'string',
  'warehouseId': 'string',
  'accountId': 'string',
  'custom': {}
}
response = requests.post(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {

}

Thrivecarts

HEAD /v1/Thrivecart/:id/order

Parameters

Path

  • id string required

    Thrivecart id

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Thrivecart/{id}/order', {
  method: 'HEAD',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X HEAD https://api.spaceinvoices.com/v1/Thrivecart/{id}/order \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Thrivecart/{id}/order'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.head(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      {

}

Create Thrivecart

POST /v1/Thrivecart/:id/import

Parameters

Path

  • id string required

    Thrivecart id

Properties

  • type string required

  • importOptions string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Thrivecart/{id}/import', {
  method: 'POST',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    type: 'string',
    importOptions: 'string'
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X POST https://api.spaceinvoices.com/v1/Thrivecart/{id}/import \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "string", \
    "importOptions": "string"
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Thrivecart/{id}/import'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'type': 'string',
  'importOptions': 'string'
}
response = requests.post(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {

}