Shopify

Endpoints:

  • GET /v1/Organizations/:id/shopify
  • POST /v1/Organizations/:id/shopify
  • GET /v1/Organizations/:id/shopify/count
  • DELETE /v1/Shopify/:id
  • PATCH /v1/Shopify/:id
  • POST /v1/Shopify/:id/order
  • POST /v1/Shopify/:id/import
  • POST /v1/Shopify/incoming
  • GET /v1/Shopify/:id/orders/document
  • GET /v1/Shopify/app

The Shopify object

Parameters

  • id string readonly

  • shop string

    Unique shop URL

  • apiKey string

  • password string

  • accessToken string

  • shopSettings object

  • 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

  • updateItemInventory boolean

    Enable updating store item inventory quantities.

  • accountId string

  • unitId string

  • warehouseId string

    • Additional propertiesExpand all 
    
      {
  "shop": "string",
  "apiKey": "string",
  "password": "string",
  "accessToken": "string",
  "shopSettings": {},
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "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",
  "updateItemInventory": true,
  "accountId": "string",
  "unitId": "string",
  "warehouseId": "string"
}

Find Shopifies

GET /v1/Organizations/:id/shopify

Parameters

Path

  • id string required

    Organization id

Query

  • filter string optional 

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

Your access token displayed in examples.

Response:

    
      [
  {
    "shop": "string",
    "apiKey": "string",
    "password": "string",
    "accessToken": "string",
    "shopSettings": {},
    "name": "string",
    "active": true,
    "locale": "string",
    "sendInvoiceAutomatically": true,
    "sendEstimateAutomatically": true,
    "issueInvoiceForBankPayment": true,
    "issueInvoiceOnComplete": true,
    "businessPremiseId": "string",
    "electronicDeviceId": "string",
    "id": "string",
    "organizationId": "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",
    "updateItemInventory": true,
    "accountId": "string",
    "unitId": "string",
    "warehouseId": "string"
  }
]

Create Shopify

POST /v1/Organizations/:id/shopify

Parameters

Path

  • id string required

    Organization id

Properties

  • shop string required

    Unique shop URL

  • 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

  • apiKey string optional

  • password string optional

  • accessToken string optional

  • shopSettings object optional

  • 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

  • updateItemInventory boolean optional

    Enable updating store item inventory quantities.

  • accountId string optional

  • unitId string optional

  • warehouseId string optional

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

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

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

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {
  "shop": "string",
  "apiKey": "string",
  "password": "string",
  "accessToken": "string",
  "shopSettings": {},
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "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",
  "updateItemInventory": true,
  "accountId": "string",
  "unitId": "string",
  "warehouseId": "string"
}

Count Shopifies

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

DELETE /v1/Shopify/:id

Parameters

Path

  • id string required

    Model id

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

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Shopify/{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 Shopify

PATCH /v1/Shopify/:id

Parameters

Path

  • id string required

    Shopify id

Properties

  • shop string required

    Unique shop URL

  • 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

  • apiKey string optional

  • password string optional

  • accessToken string optional

  • shopSettings object optional

  • 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

  • updateItemInventory boolean optional

    Enable updating store item inventory quantities.

  • accountId string optional

  • unitId string optional

  • warehouseId string optional

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

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X PATCH https://api.spaceinvoices.com/v1/Shopify/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "shop": "string", \
    "apiKey": "string", \
    "password": "string", \
    "accessToken": "string", \
    "shopSettings": {}, \
    "name": "string", \
    "active": true, \
    "locale": "string", \
    "sendInvoiceAutomatically": true, \
    "sendEstimateAutomatically": true, \
    "issueInvoiceForBankPayment": true, \
    "issueInvoiceOnComplete": true, \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "organizationId": "string", \
    "custom": {}, \
    "updateItemInventory": true, \
    "accountId": "string", \
    "unitId": "string", \
    "warehouseId": "string"
  }'

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {
  "shop": "string",
  "apiKey": "string",
  "password": "string",
  "accessToken": "string",
  "shopSettings": {},
  "name": "string",
  "active": true,
  "locale": "string",
  "sendInvoiceAutomatically": true,
  "sendEstimateAutomatically": true,
  "issueInvoiceForBankPayment": true,
  "issueInvoiceOnComplete": true,
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "id": "string",
  "organizationId": "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",
  "updateItemInventory": true,
  "accountId": "string",
  "unitId": "string",
  "warehouseId": "string"
}

Create Shopify

POST /v1/Shopify/:id/order

Parameters

Path

  • id string required

    Shopify id

Properties

  • shop string required

    Unique shop URL

  • 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

  • apiKey string optional

  • password string optional

  • accessToken string optional

  • shopSettings object optional

  • 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

  • updateItemInventory boolean optional

    Enable updating store item inventory quantities.

  • accountId string optional

  • unitId string optional

  • warehouseId string optional

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

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

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

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {

}

Create Shopify

POST /v1/Shopify/:id/import

Parameters

Path

  • id string required

    Shopify id

Properties

  • type string required

  • importOptions string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Shopify/{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/Shopify/{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/Shopify/{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:

    
      {

}

Create Shopify

POST /v1/Shopify/incoming

Parameters

Query

  • shopifyToken string required

    Shopify token used to authenticate the source of req.

Properties

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

  }'

Your access token displayed in examples.

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

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

Your access token displayed in examples.

Response:

    
      {

}

Find Shopifies

GET /v1/Shopify/:id/orders/document

Parameters

Path

  • id string required

    Shopify id

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

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {

}

Find Shopifies

GET /v1/Shopify/app

Parameters

Query

  • shop string optional

    Shop domain

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

Your access token displayed in examples.

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

Your access token displayed in examples.

Response:

    
      {

}