Skip to main content

Stores

A Store is a subset of a Company. It can be linked to a set of Catalogs and modify their prices.

Store methods​

Returns a list of all Stores matching some specified search criteria.

info

A “web user” (i.e. linked to at least one web store) will also be returned the stores he is not explicitly assigned to.

Method​

GET/api/externals/v1/stores

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • code (string): Code of the searched Stores
  • keyword (string): Searched keyword
  • idsOnly (boolean, true): If true, returns only a set of Store IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Stores (e.g. "billingAddress", "legalInformation", "attachments")

Body​

(none)

Response​

The search service returns a JSON message with the list of items matching the specified search criteria:

{
  "stores": [
    { 
      "id": long, 
      "code": string,
      "name": string,
      "mainAddress": {
        "title": string,
        "firstName": string,
        "lastName": string,
        "companyName": string,
        "street1": string,
        "street2": string,
        "street3": string,
        "zipCode": string,
        "city": string,
        "countryCode": string
      },
      "billingAddress": {
        "title": string,
        "firstName": string,
        "lastName": string,
        "companyName": string,
        "street1": string,
        "street2": string,
        "street3": string,
        "zipCode": string,
        "city": string,
        "countryCode": string
      },
      "mobilePhone": string,
      "homePhone": string,
      "emailAddress": string,
      "webSiteUrl": string,
      "legalInformation": {
        "siret": string,
        "apeCode": string,
        "intercommunityCode": string,
        "rcs": string,
        "rcsCode": string,
        "capital": double,
        "rge": string,
        "decennial": string,
        "declarantCode": string
      },
      "attachments": [
        {
          "id": long,
          "url": string,
          "description": string,
          "fileTypeID": int,
          "fileAssociateTypeID": int,
          "creationDate": datetime
        }
      ]
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Store which storeID is provided in the URL.

Method​

GET/api/externals/v1/stores/{storeID}

Arguments​

  • storeID (long): (provided in the path): ID of the Store to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • detailedView (boolean, false): If true, returns additional information about the matching Store (e.g. "billingAddress", "legalInformation", "attachments")

Body​

(none)

Response​

Same format as the one returned by the « Store search » method.

Store additional methods​

Catalogs​

Returns a list of all Catalogs owned by the Store which storeID is provided in the URL and matching some specified search criteria.

Method​

GET/api/externals/v1/stores/{storeID}/catalogs

Arguments​

  • storeID (long): (provided in the path): ID of the Store owning the searched Catalogs
  • winLangID (long): Windows Language Identifier of the resulting data
  • supplierID (long): ID of the Supplier owning the searched Catalogs
  • internalCode (string): Internal code of the searched Catalogs
  • code (string): Code of the searched Catalogs
  • keyword (string): Searched keyword
  • minDate (datetime): Minimum date of the searched Catalogs
  • maxDate (datetime): Maximum date of the searched Catalogs
  • dateKind (string): Type of date used by the minDate and/or maxDate arguments. Allowed values: "CreationDate", "LastModificationDate"
  • idsOnly (boolean, true): If true, returns only a set of Catalog IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Catalogs (e.g. "coefficients", "attachments")

Body​

(none)

Response​

Same format as the one returned by the « Catalog search » method.