Dev Docs

Dev Docs
Back to support
Back to support

OrgStructure Store API

Endpoint

The importconfigkey for the OrgStructure Store Import is  defaultImportStoresV1.

Body

The valid json looks like that:

[

  {

    "__id": "{{__id}}",

    "__organizationalId": "{{__organizationalId}}",

    "parentId": "{{parentId}}",

    "structureInformation": {

      "name": {

        "i18nVariants": {

          "en_US": "{{name_en_US}}",

          "de_DE": "{{name_de_DE}}"

        }

      }

    },

  "settings": {

    "storeId": "{{storeId}}",

    "taxId": {{taxId}},

    "emailAddress": "{{emailAddress}}",

    "website": "{{Website}}",

    "address": {

      "type": "{{address/type}}",

      "address": "{{address/address}}",

      "postalcode": "{{address/postalcode}}",

      "city": "{{address/city}}",

      "state": "{{address/state}}",

      "country": "{{address/country}}",

      "telephone": [

	"{{address/phone}}"

      ],

      "fax": [

	"{{address/fax}}"

      ],

      "addressLine": [

	""

      ],

      "latitude": {{latitude}},

      "longitude": {{longitude}}

    },

    "locale": "{{locale}}"

  }

}

]


Definition

Field



__id

Type: "NNNN" - string

Sample: "12345"

Description: The internal, unique ID of the store.

__organizationalId

Type: "NNNN" - string

Sample: "-1"

Description: The unique ID for the concerning organization structure. By default "-1".

parentId

Type: "NNNN" - string

Sample: "12345"

Description: The internal, unique ID of the parent within the organizational structure.

name_de_de
name_en_us

Type: "TEXT" - string

Sample: "Store New York"

Description: The name of the store.

storeId

Type: "NNNN" - string

Sample: "12345"

Description: The visible ID of the store.

taxId

Type: "NNNNN" - string

Sample: "12345"

Description: The tax id which belongs to the store.

emailAddress

Type: "NNNNN" - string

Sample: "12345"

Description: 

Website

Type: "TEXT" - string

Sample: "www.retail7.io"

Description: The website which belongs to the store.

address/type

Type: "TEXT" - string

Sample: "default_address", "invoice_address", "delivery_address" or "other_address"

Description: The type of the corresponding address.

address/address

Type: "TEXT" - string

Sample: "Main Street 1"

Description: The address of the corresponding address.

address/postalcode

Type: "NNNNN" - string

Sample: "12345"

Description: The postal code of the store.

address/city

Type: "TEXT" - string

Sample: "New York City"

Description: The city of the corresponding store.

address/state

Type: "TEXT" - string

Sample: "New York"

Description: The state of the corresponding store.

address/country

Type: "TEXT" - string

Sample: "germany"

Description: The country of the corresponding store.

address/phone

Type: "NNNNN" - string

Sample: "12345"

Description: The phone number of the store.

address/fax

Type: "NNNNN" - string

Sample: "12345"

Description: The fax number of the store.

latitude

Type: "NNNNN" - string

Sample: "40.758895"

Description: The degree of latitude.

longitude

Type: "NNNNN" - string

Sample: "-73.985131"

Description: The degree of longitude.

locale

Type: "TEXT" - string

Sample: "en_US"

Description: The abbreviation for the locale corresponding to the store.

Example case

The Postman project below contains all the necessary files to illustrate an example use-case.

Download postman project "Organizational Structure - Stores Import (API)"

  1. Import all the existing .json files into postman.

  2. Enter the following data in the included environments:

    - baseURL

    - username

    - password

    Leave all other entries unchanged.

  3. Open the imported "R7 API | Org. Structure Stores"-Collection in the postman app.

  4. On the top right corner, assign the imported "R7 API | Org. Structure Stores"-Environment to the opened collection.

  5. Click the "Send"-Button to send the post to your management console.



Result: The store should now appear in the mangement console.