Quick Start

Our base domain URL is https://api.dotapparel.io. Before you get started, please make sure you have an account with us. If you do not have an account, please reach out to us to request an admin account.

Get your API keys

Our API uses basic authentication with username and password. To authenticate your requests, include your username and password as a header in your HTTP requests.

Authorization: Basic <YOUR_API_KEY>

Please note that all API requests must be made over HTTPS.

Make your first request

To make your first API request, you will need to specify the API endpoint and any required parameters.

Make sure to include your username and password in the request header as described in the Authentication section above, as well as the X-DotApparel-Name header with the correct value for your account.

For example, if you want to retrieve a list of all stores, you can make a GET request to the following endpoint:

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

basic

AuthorizationstringRequired

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

/stores

HTTPcURLJavaScriptPython

GET /stores HTTP/1.1
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
    }
  ]
}

You may want to consider using Postman to create your own requests or you can quickly view the API by using the following curl command.

Take a look at how you might call this method using via curl:

curl

curl -X 'GET' \
  'https://api.dotapparel.io/stores' \
  -H 'accept: application/json' \
  -H 'X-DotApparel-Name: YOUR_VALUE' \
  -H 'Authorization: Basic YOUR_API_KEY'

If successful, the API will return a JSON object containing the list of stores.

That's it! You're now ready to start exploring our API documentation and building your own applications. If you have any questions or need further assistance, please do not hesitate to reach out to us at [email protected]. Happy coding!