Stores

Our base domain URL is https://api.dotapparel.io.

Retrieve multiple stores

get

Scope: visitor and above

This endpoint retrieves information about stores in the Apparel21.

The endpoint can accept particular Shopify location ID. If a location ID is provided, the endpoint will only look up the stores that are associated with the location.

The endpoint returns a list of object that includes information such as the store id, store number, address and contact details.

Authorizations

Query parameters

shopifyLocationIdnumberOptional

The Shopify location ID

Header parameters

X-DotApparel-NamestringRequired

An alias name that represents a particular brand that is using the API

shopstringRequired

Responses

200

Successful response

application/json

401

Unauthorized: The user is not authorized to perform this action.

get

HTTPcURLJavaScriptPython

GET /stores HTTP/1.1
Host: 
Authorization: Basic username:password
X-DotApparel-Name: text
shop: text
Accept: */*

{
  "data": [
    {
      "storeId": 1001,
      "storeNumber": 123,
      "code": "EXAMPLE_STORE_CODE",
      "address1": "111 Cecil St",
      "address2": "Level 5",
      "city": "South Melbourne",
      "state": "VIC",
      "country": "Australia",
      "postcode": 3205,
      "name": "Example Store",
      "email": "[email protected]",
      "shopifyLocationId": 1234567
    }
  ]
}

Retrieve a single store by store number

get

Scope: visitor and above

This endpoint retrieves information about a single store in the Apparel21 system by accepting a required store number parameter.

The endpoint checks that the store number is valid and associated with an existing store record. If the store number is valid, the endpoint retrieves the store's ID, store number, address, and contact information.

Authorizations

Path parameters

store_numbernumberRequired

The Apparel21 store number

Header parameters

X-DotApparel-NamestringRequired

An alias name that represents a particular brand that is using the API

shopstringRequired

Responses

200

Successful response

application/json

400

Bad Request: The store number was invalid.

401

Unauthorized: The user is not authorized to perform this action.

404

Not Found: The store with the specified store number was not found.

get

HTTPcURLJavaScriptPython

GET /stores/{store_number} HTTP/1.1
Host: 
Authorization: Basic username:password
X-DotApparel-Name: text
shop: text
Accept: */*

{
  "data": {
    "storeId": 1001,
    "storeNumber": 123,
    "code": "EXAMPLE_STORE_CODE",
    "address1": "111 Cecil St",
    "address2": "Level 5",
    "city": "South Melbourne",
    "state": "VIC",
    "country": "Australia",
    "postcode": 3205,
    "name": "Example Store",
    "email": "[email protected]",
    "shopifyLocationId": 1234567
  }
}