Endpoints:
- GET /v1/Organizations/:id/magento1
- POST /v1/Organizations/:id/magento1
- GET /v1/Organizations/:id/magento1/count
- DELETE /v1/Magento1/:id
- PATCH /v1/Magento1/:id
- POST /v1/Magento1/:id/order
- POST /v1/Magento1/:id/import
The Magento1 object
Parameters
-
id string readonly
-
host string
Store host address used for API
-
apiUser string
-
apiKey string
-
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
-
updateItemInventory boolean
Enable updating store item inventory quantities.
-
Custom field for freeform data input
-
deletedAt date readonly
-
_isDeleted boolean readonly
-
deletedId string readonly
-
createdAt date readonly
-
updatedAt date readonly
Additional propertiesExpand all
{
"host": "string",
"apiUser": "string",
"apiKey": "string",
"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",
"updateItemInventory": true
}
Find Magento1s
GET /v1/Organizations/:id/magento1
Parameters
Path
-
id string required
Organization id
Query
-
filter string optional
const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/magento1', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/magento1 \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/magento1'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
[
{
"host": "string",
"apiUser": "string",
"apiKey": "string",
"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",
"updateItemInventory": true
}
]
Create Magento1
POST /v1/Organizations/:id/magento1
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
-
host string optional
Store host address used for API
-
apiUser string optional
-
apiKey string 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
-
unitId string optional
-
warehouseId string optional
-
accountId string optional
-
updateItemInventory boolean optional
Enable updating store item inventory quantities.
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/magento1', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
host: 'string',
apiUser: 'string',
apiKey: 'string',
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: {},
updateItemInventory: true
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/Organizations/{id}/magento1 \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"host": "string", \
"apiUser": "string", \
"apiKey": "string", \
"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": {}, \
"updateItemInventory": true
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/magento1'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'host': 'string',
'apiUser': 'string',
'apiKey': 'string',
'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': {},
'updateItemInventory': True
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"host": "string",
"apiUser": "string",
"apiKey": "string",
"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",
"updateItemInventory": true
}
Count Magento1s
GET /v1/Organizations/:id/magento1/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}/magento1/count', {
method: 'GET',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/magento1/count \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/magento1/count'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 42
}
const response = await fetch('https://api.spaceinvoices.com/v1/Magento1/{id}', {
method: 'DELETE',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
}
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X DELETE https://api.spaceinvoices.com/v1/Magento1/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Magento1/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"count": 1
}
Patch Magento1
PATCH /v1/Magento1/:id
Parameters
Path
-
id string required
Magento1 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
-
host string optional
Store host address used for API
-
apiUser string optional
-
apiKey string 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
-
unitId string optional
-
warehouseId string optional
-
accountId string optional
-
updateItemInventory boolean optional
Enable updating store item inventory quantities.
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/Magento1/{id}', {
method: 'PATCH',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
host: 'string',
apiUser: 'string',
apiKey: 'string',
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: {},
updateItemInventory: true
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X PATCH https://api.spaceinvoices.com/v1/Magento1/{id} \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"host": "string", \
"apiUser": "string", \
"apiKey": "string", \
"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": {}, \
"updateItemInventory": true
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Magento1/{id}'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'host': 'string',
'apiUser': 'string',
'apiKey': 'string',
'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': {},
'updateItemInventory': True
}
response = requests.patch(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
"host": "string",
"apiUser": "string",
"apiKey": "string",
"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",
"updateItemInventory": true
}
Create Magento1
POST /v1/Magento1/:id/order
Parameters
Path
-
id string required
Magento1 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
-
host string optional
Store host address used for API
-
apiUser string optional
-
apiKey string 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
-
unitId string optional
-
warehouseId string optional
-
accountId string optional
-
updateItemInventory boolean optional
Enable updating store item inventory quantities.
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
const response = await fetch('https://api.spaceinvoices.com/v1/Magento1/{id}/order', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
host: 'string',
apiUser: 'string',
apiKey: 'string',
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: {},
updateItemInventory: true
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/Magento1/{id}/order \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"host": "string", \
"apiUser": "string", \
"apiKey": "string", \
"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": {}, \
"updateItemInventory": true
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Magento1/{id}/order'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'host': 'string',
'apiUser': 'string',
'apiKey': 'string',
'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': {},
'updateItemInventory': True
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
}
Create Magento1
POST /v1/Magento1/:id/import
Parameters
Path
-
id string required
Magento1 id
Properties
-
type string required
-
importOptions string optional
const response = await fetch('https://api.spaceinvoices.com/v1/Magento1/{id}/import', {
method: 'POST',
headers: {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json'
},
body: JSON.stringify({
type: 'string',
importOptions: 'string'
})
});
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
curl -X POST https://api.spaceinvoices.com/v1/Magento1/{id}/import \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"type": "string", \
"importOptions": "string"
}'
Login to auto-insert your own access token.
Your access token displayed in examples.
import requests
url = 'https://api.spaceinvoices.com/v1/Magento1/{id}/import'
headers = {
'Authorization': 'ACCESS_TOKEN',
'content-type': 'application/json',
}
params = {
'type': 'string',
'importOptions': 'string'
}
response = requests.post(url, json=params, headers=headers)
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
{
}