Endpoints:
- GET /v1/Organizations/:id/woocommerce
- POST /v1/Organizations/:id/woocommerce
- GET /v1/Organizations/:id/woocommerce/count
- DELETE /v1/Woocommerce/:id
- PATCH /v1/Woocommerce/:id
- POST /v1/Woocommerce/:id/order
- POST /v1/Woocommerce/:id/import
The Woocommerce object
Parameters
-
id string readonly
-
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
-
Custom field for freeform data input
-
deletedAt date readonly
-
_isDeleted boolean readonly
-
deletedId string readonly
-
createdAt date readonly
-
updatedAt date readonly
Additional propertiesExpand all
Find Woocommerces
GET /v1/Organizations/:id/woocommerce
Parameters
Path
-
id string required
Organization id
Query
-
filter string optional
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Create Woocommerce
POST /v1/Organizations/:id/woocommerce
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
-
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
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Count Woocommerces
GET /v1/Organizations/:id/woocommerce/count
Parameters
Path
-
id string required
Organization id
Query
-
where string optional
Criteria to match model instances
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Patch Woocommerce
PATCH /v1/Woocommerce/:id
Parameters
Path
-
id string required
Woocommerce 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
-
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
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Create Woocommerce
POST /v1/Woocommerce/:id/order
Parameters
Path
-
id string required
Woocommerce 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
-
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
-
Default is: {}
Custom field for freeform data input
Additional propertiesExpand all
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response:
Create Woocommerce
POST /v1/Woocommerce/:id/import
Parameters
Path
-
id string required
Woocommerce id
Properties
-
type string required
-
importOptions string optional
Login to auto-populate your access token.
Your access token is displayed in examples.
Prerequisite: npm install node-fetch
Login to auto-insert your own access token.
Your access token displayed in examples.
Login to auto-insert your own access token.
Your access token displayed in examples.
Response: