Sales | Store
Service to manage entities of type 'Store'.
Overview
URL | api/{tenantKey}/{orgKey}/salesCore/stores |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Stores (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See StoreResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Store by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See StoreResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Store by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
storeKey | (string) The store's key. |
Response:
When successful, the response body contains the entity record. See StoreResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Stores
Creates a new entity record.
The following elements are required:
storeResource | (ApiStoreResource) The request body should contain the entity record that should be created. See ApiStoreResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiStoreResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description Store
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Store
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set PartyTaxSchema Store
Updates the value of attribute 'PartyTaxSchema' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SalesChannel Store
Updates the value of attribute 'SalesChannel' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SourceFinancialAccountForCashOpening Store
Updates the value of attribute 'SourceFinancialAccountForCashOpening' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set StoreKey Store
Updates the value of attribute 'StoreKey' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TargetFinancialAccountForCashClosing Store
Updates the value of attribute 'TargetFinancialAccountForCashClosing' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Warehouse Store
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
storeKey | (string) The store's key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Store by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Store by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
storeKey | (string) The store's key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiStoreResource
The following elements are required:
storeKey | (string) The store's key. |
description | (string) The store description. |
company | (string) The store's company. The company code is the central organizational unit within the system. |
salesChannel | (string) Indicates the sales channel used by default for this store. |
warehouse | (string) Indicates the warehouse used by default for this store. |
partyTaxSchema | (string) The store's party tax schema. The tax schema identifies the group of taxes to use. |
sourceFinancialAccountForCashOpening | (string) The financial account to use on opening cash operation. |
targetFinancialAccountForCashClosing | (string) The financial account to use on closing cash operation. |
StoreResource
The following elements are required:
storeKey | (string) The store's key. |
description | (string) The store description. |
company | (string) The store's company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
salesChannel | (string) Indicates the sales channel used by default for this store.
(fk) Allowed value: the natural key of a record of type SalesChannel. These records are accessibly through the SalesChannels service. |
warehouse | (string) Indicates the warehouse used by default for this store.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |
partyTaxSchema | (string) The store's party tax schema. The tax schema identifies the group of taxes to use.
(fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service. |
sourceFinancialAccountForCashOpening | (string) The financial account to use on opening cash operation.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |
targetFinancialAccountForCashClosing | (string) The financial account to use on closing cash operation.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service. |