Sales | Store

Service to manage entities of type 'Store'.

Overview

api/{tenantKey}/{orgKey}/salesCore/stores

URL	api/{tenantKey}/{orgKey}/salesCore/stores
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Stores
PUT:
DELETE:
- DELETE Store by identifier
- DELETE Store by key

All Resources

This service uses the following resources:

ApiStoreResource
StoreResource

GET Operations

GET Stores

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/salesCore/stores

GET /salesCore/stores

GET Stores (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/salesCore/stores?page={page}&pageSize={pageSize}

GET /salesCore/stores?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{id}

GET /salesCore/stores/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}

GET /salesCore/stores/{companyKey}/{storeKey}

GET Print Store by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/stores/{id}/print?template={template}

GET /salesCore/stores/{id}/print?template={template}

GET Print Store by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
storeKey	(string) The store's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/print

GET /salesCore/stores/{companyKey}/{storeKey}/print

GET Original Print StoreOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/stores/{id}/printOriginal?template={template}

GET /salesCore/stores/{id}/printOriginal?template={template}

GET Original Print Store by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
storeKey	(string) The store's key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/printOriginal

GET /salesCore/stores/{companyKey}/{storeKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/salesCore/stores

POST /salesCore/stores

PUT Operations

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/description

PUT /salesCore/stores/{companyKey}/{storeKey}/description

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/isActive

PUT /salesCore/stores/{companyKey}/{storeKey}/isActive

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/partyTaxSchema

PUT /salesCore/stores/{companyKey}/{storeKey}/partyTaxSchema

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/salesChannel

PUT /salesCore/stores/{companyKey}/{storeKey}/salesChannel

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/sourceFinancialAccountForCashOpening

PUT /salesCore/stores/{companyKey}/{storeKey}/sourceFinancialAccountForCashOpening

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/storeKey

PUT /salesCore/stores/{companyKey}/{storeKey}/storeKey

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/targetFinancialAccountForCashClosing

PUT /salesCore/stores/{companyKey}/{storeKey}/targetFinancialAccountForCashClosing

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}/warehouse

PUT /salesCore/stores/{companyKey}/{storeKey}/warehouse

DELETE Operations

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{id}

DELETE /salesCore/stores/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/stores/{companyKey}/{storeKey}

DELETE /salesCore/stores/{companyKey}/{storeKey}

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.