Order

Endpoints:

  • GET /v1/Organizations/:id/orders
  • GET /v1/Organizations/:id/orders/count
  • GET /v1/Orders/:id
  • POST /v1/Orders/:id/documents/create

The Order object

Parameters

  • id string readonly

  • status string

  • date date

  • orderId string

    Store order id

  • number string

    Store order number

  • currencyId string

  • paymentType string

  • paymentTag string

  • paid boolean

  • paidAt date

  • fulfilled boolean

  • fulfilledAt date

  • cancelled boolean

  • cancelledAt date

  • complete boolean

  • completedAt date

  • refunded boolean

  • refundedAt date

  • locale string

    Order specific locale

  • expectedTotalWithTax number

  • payloads array[object]

    Order original payloads

  • taxClause string

    Custom tax clause passed from order

  • _billingAddress object

    show nested properties
  • _shippingAddress object

    show nested properties
  • invoiceId string

  • estimateId string

  • organizationId string

  • shopifyId string

  • magento1Id string

  • woocommerceId string

  • customIntegrationId string

  • customId string

  • thrivecartId string

  • _items array[object]

    show nested properties
  • _transactions array[object]

    show nested properties
  • bokunId string

  • shopamineId string

  • Additional propertiesExpand all
    
      {
  "status": "string",
  "date": "2022-04-20T10:10:30+00:00Z",
  "orderId": "string",
  "number": "string",
  "currencyId": "string",
  "paymentType": "string",
  "paymentTag": "string",
  "paid": true,
  "paidAt": "2022-04-20T10:10:30+00:00Z",
  "fulfilled": true,
  "fulfilledAt": "2022-04-20T10:10:30+00:00Z",
  "cancelled": true,
  "cancelledAt": "2022-04-20T10:10:30+00:00Z",
  "complete": true,
  "completedAt": "2022-04-20T10:10:30+00:00Z",
  "refunded": true,
  "refundedAt": "2022-04-20T10:10:30+00:00Z",
  "locale": "string",
  "expectedTotalWithTax": 42,
  "payloads": [{}],
  "taxClause": "string",
  "id": "string",
  "_billingAddress": {
    "id": "string",
    "isEndCustomer": false,
    "throwEslogErrors": true,
    "ipAddress": "string",
    "fatturaPaChannelId": "string",
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "state": "string",
    "country": "string",
    "countryAlpha2Code": "string",
    "taxNumber": "string",
    "taxSubject": true,
    "companyNumber": "string",
    "IBAN": "string",
    "bank": "string",
    "SWIFT": "string",
    "website": "string",
    "email": "string",
    "phone": "string",
    "businessType": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z",
    "custom": {},
    "_data": [{
      "id": "string",
      "name": "string",
      "value": {},
      "options": {}
    }]
  },
  "_shippingAddress": {
    "id": "string",
    "isEndCustomer": false,
    "throwEslogErrors": true,
    "ipAddress": "string",
    "fatturaPaChannelId": "string",
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "state": "string",
    "country": "string",
    "countryAlpha2Code": "string",
    "taxNumber": "string",
    "taxSubject": true,
    "companyNumber": "string",
    "IBAN": "string",
    "bank": "string",
    "SWIFT": "string",
    "website": "string",
    "email": "string",
    "phone": "string",
    "businessType": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z",
    "custom": {},
    "_data": [{
      "id": "string",
      "name": "string",
      "value": {},
      "options": {}
    }]
  },
  "invoiceId": "string",
  "estimateId": "string",
  "organizationId": "string",
  "shopifyId": "string",
  "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",
  "magento1Id": "string",
  "woocommerceId": "string",
  "customIntegrationId": "string",
  "customId": "string",
  "thrivecartId": "string",
  "_items": [{
    "id": "string",
    "name": "string",
    "description": "",
    "price": 42,
    "priceGross": 42,
    "unit": "string",
    "SKU": "string",
    "onBehalf": "string",
    "custom": {},
    "_taxes": [{
      "id": "string",
      "rate": 42,
      "name": "string",
      "abbreviation": "string",
      "recoverable": true,
      "compound": false,
      "taxNumber": "string"
    }]
  }],
  "_transactions": [{
    "id": "string",
    "amount": 42,
    "gateway": "string",
    "type": "string",
    "status": "string",
    "tag": "string",
    "date": "2022-04-20T10:10:30+00:00Z",
    "note": "string",
    "custom": {}
  }],
  "bokunId": "string",
  "shopamineId": "string"
}    
  

Find Orders

GET /v1/Organizations/:id/orders

Parameters

Path
  • id string required

    Organization id

Query
  • filter string optional

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/orders', {
  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}/orders \
  -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}/orders'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)        
      

Your access token displayed in examples.

Response:

    
      [
  {
    "status": "string",
    "date": "2022-04-20T10:10:30+00:00Z",
    "orderId": "string",
    "number": "string",
    "currencyId": "string",
    "paymentType": "string",
    "paymentTag": "string",
    "paid": true,
    "paidAt": "2022-04-20T10:10:30+00:00Z",
    "fulfilled": true,
    "fulfilledAt": "2022-04-20T10:10:30+00:00Z",
    "cancelled": true,
    "cancelledAt": "2022-04-20T10:10:30+00:00Z",
    "complete": true,
    "completedAt": "2022-04-20T10:10:30+00:00Z",
    "refunded": true,
    "refundedAt": "2022-04-20T10:10:30+00:00Z",
    "locale": "string",
    "expectedTotalWithTax": 42,
    "payloads": [{}],
    "taxClause": "string",
    "id": "string",
    "_billingAddress": {
      "id": "string",
      "isEndCustomer": false,
      "throwEslogErrors": true,
      "ipAddress": "string",
      "fatturaPaChannelId": "string",
      "name": "string",
      "address": "string",
      "address2": "string",
      "city": "string",
      "zip": "string",
      "state": "string",
      "country": "string",
      "countryAlpha2Code": "string",
      "taxNumber": "string",
      "taxSubject": true,
      "companyNumber": "string",
      "IBAN": "string",
      "bank": "string",
      "SWIFT": "string",
      "website": "string",
      "email": "string",
      "phone": "string",
      "businessType": "string",
      "createdAt": "2022-04-20T10:10:30+00:00Z",
      "updatedAt": "2022-04-20T10:10:30+00:00Z",
      "custom": {},
      "_data": [{
        "id": "string",
        "name": "string",
        "value": {},
        "options": {}
      }]
    },
    "_shippingAddress": {
      "id": "string",
      "isEndCustomer": false,
      "throwEslogErrors": true,
      "ipAddress": "string",
      "fatturaPaChannelId": "string",
      "name": "string",
      "address": "string",
      "address2": "string",
      "city": "string",
      "zip": "string",
      "state": "string",
      "country": "string",
      "countryAlpha2Code": "string",
      "taxNumber": "string",
      "taxSubject": true,
      "companyNumber": "string",
      "IBAN": "string",
      "bank": "string",
      "SWIFT": "string",
      "website": "string",
      "email": "string",
      "phone": "string",
      "businessType": "string",
      "createdAt": "2022-04-20T10:10:30+00:00Z",
      "updatedAt": "2022-04-20T10:10:30+00:00Z",
      "custom": {},
      "_data": [{
        "id": "string",
        "name": "string",
        "value": {},
        "options": {}
      }]
    },
    "invoiceId": "string",
    "estimateId": "string",
    "organizationId": "string",
    "shopifyId": "string",
    "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",
    "magento1Id": "string",
    "woocommerceId": "string",
    "customIntegrationId": "string",
    "customId": "string",
    "thrivecartId": "string",
    "_items": [{
      "id": "string",
      "name": "string",
      "description": "",
      "price": 42,
      "priceGross": 42,
      "unit": "string",
      "SKU": "string",
      "onBehalf": "string",
      "custom": {},
      "_taxes": [{
        "id": "string",
        "rate": 42,
        "name": "string",
        "abbreviation": "string",
        "recoverable": true,
        "compound": false,
        "taxNumber": "string"
      }]
    }],
    "_transactions": [{
      "id": "string",
      "amount": 42,
      "gateway": "string",
      "type": "string",
      "status": "string",
      "tag": "string",
      "date": "2022-04-20T10:10:30+00:00Z",
      "note": "string",
      "custom": {}
    }],
    "bokunId": "string",
    "shopamineId": "string"
  }
]    
  

Count Orders

GET /v1/Organizations/:id/orders/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}/orders/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}/orders/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}/orders/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
}    
  

Get Order

GET /v1/Orders/:id

Parameters

Path
  • id string required

    Model id

Query
  • filter string optional

    Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Orders/{id}', {
  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/Orders/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'        
      

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {
  "status": "string",
  "date": "2022-04-20T10:10:30+00:00Z",
  "orderId": "string",
  "number": "string",
  "currencyId": "string",
  "paymentType": "string",
  "paymentTag": "string",
  "paid": true,
  "paidAt": "2022-04-20T10:10:30+00:00Z",
  "fulfilled": true,
  "fulfilledAt": "2022-04-20T10:10:30+00:00Z",
  "cancelled": true,
  "cancelledAt": "2022-04-20T10:10:30+00:00Z",
  "complete": true,
  "completedAt": "2022-04-20T10:10:30+00:00Z",
  "refunded": true,
  "refundedAt": "2022-04-20T10:10:30+00:00Z",
  "locale": "string",
  "expectedTotalWithTax": 42,
  "payloads": [{}],
  "taxClause": "string",
  "id": "string",
  "_billingAddress": {
    "id": "string",
    "isEndCustomer": false,
    "throwEslogErrors": true,
    "ipAddress": "string",
    "fatturaPaChannelId": "string",
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "state": "string",
    "country": "string",
    "countryAlpha2Code": "string",
    "taxNumber": "string",
    "taxSubject": true,
    "companyNumber": "string",
    "IBAN": "string",
    "bank": "string",
    "SWIFT": "string",
    "website": "string",
    "email": "string",
    "phone": "string",
    "businessType": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z",
    "custom": {},
    "_data": [{
      "id": "string",
      "name": "string",
      "value": {},
      "options": {}
    }]
  },
  "_shippingAddress": {
    "id": "string",
    "isEndCustomer": false,
    "throwEslogErrors": true,
    "ipAddress": "string",
    "fatturaPaChannelId": "string",
    "name": "string",
    "address": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "state": "string",
    "country": "string",
    "countryAlpha2Code": "string",
    "taxNumber": "string",
    "taxSubject": true,
    "companyNumber": "string",
    "IBAN": "string",
    "bank": "string",
    "SWIFT": "string",
    "website": "string",
    "email": "string",
    "phone": "string",
    "businessType": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z",
    "custom": {},
    "_data": [{
      "id": "string",
      "name": "string",
      "value": {},
      "options": {}
    }]
  },
  "invoiceId": "string",
  "estimateId": "string",
  "organizationId": "string",
  "shopifyId": "string",
  "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",
  "magento1Id": "string",
  "woocommerceId": "string",
  "customIntegrationId": "string",
  "customId": "string",
  "thrivecartId": "string",
  "_items": [{
    "id": "string",
    "name": "string",
    "description": "",
    "price": 42,
    "priceGross": 42,
    "unit": "string",
    "SKU": "string",
    "onBehalf": "string",
    "custom": {},
    "_taxes": [{
      "id": "string",
      "rate": 42,
      "name": "string",
      "abbreviation": "string",
      "recoverable": true,
      "compound": false,
      "taxNumber": "string"
    }]
  }],
  "_transactions": [{
    "id": "string",
    "amount": 42,
    "gateway": "string",
    "type": "string",
    "status": "string",
    "tag": "string",
    "date": "2022-04-20T10:10:30+00:00Z",
    "note": "string",
    "custom": {}
  }],
  "bokunId": "string",
  "shopamineId": "string"
}    
  

Create Order

POST /v1/Orders/:id/documents/create

Parameters

Path
  • id string required

    Order id

Query
  • type string required

    Type of document to create

  • send boolean optional

    Force set if document should be sent, if not provided integration setting is used.

Properties

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Orders/{id}/documents/create', {
  method: 'POST',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({

  })
});      
    

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X POST https://api.spaceinvoices.com/v1/Orders/{id}/documents/create \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{

  }'        
      

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Orders/{id}/documents/create'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {

}
response = requests.post(url, json=params, headers=headers)        
      

Your access token displayed in examples.

Response:

    
      {

}