Products

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

Retrieve all styles with pagination

get

Scope: visitor and above

This endpoint retrieves all styles from the Apparel21 system with pagination.

The endpoint may accept optional parameters such as limit and cursor to control the amount of data returned. If no parameters are provided, the endpoint may return a default number of styles per page.

The returned data includes a list of styles with their associated information such as product code(style code), description, reference, custom data, colours and sizes.

Authorizations

Query parameters

limitnumberOptional

The maximum number of styles to return

Example: 50

cursornumberOptional

The query cursor to return a subset of data

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 /products HTTP/1.1
Host: 
Authorization: Basic username:password
X-DotApparel-Name: text
shop: text
Accept: */*

{
  "data": [
    {
      "id": 123,
      "productCode": "MTS001",
      "sizeRange": "S-XXL",
      "name": "Men's T-Shirt",
      "description": "This classic crew-neck t-shirt is made with 100% cotton and is perfect for casual wear.",
      "updatedAt": "2023-02-27T09:30:00",
      "references": {
        "brand": {
          "code": "EB",
          "name": "ExampleBrand",
          "referenceValueId": 123
        },
        "category": {
          "code": "Tshirt",
          "name": "T-Shirts",
          "referenceValueId": 123
        }
      },
      "notes": {
        "careInstructions": "Machine wash cold, tumble dry low. Do not bleach."
      },
      "customData": {
        "online": {
          "newArrival": "true",
          "onlineExclusive": "true",
          "productType": "Casual"
        }
      },
      "colours": {
        "id": 123,
        "shopifyProductId": 1234567890,
        "colour": {
          "code": "text",
          "name": "text"
        },
        "markdownStatus": "None",
        "colourType": {
          "code": "text",
          "name": "text"
        },
        "references": {
          "subCategory": {
            "code": "Men",
            "name": "Men's",
            "referenceValueId": 123
          }
        },
        "notes": {
          "colour": "White"
        },
        "customData": {
          "online": {
            "newArrival": "false",
            "onlineExclusive": "false",
            "productType": "Casual"
          }
        },
        "sizes": {
          "id": 123,
          "sizeCode": "S",
          "originalPrice": 300,
          "price": 100,
          "sequence": 1,
          "barcode": "1234567890"
        }
      }
    }
  ],
  "meta": {
    "cursor": 1
  }
}

Retrieve a single styles by id

get

Scope: visitor and above

This endpoint retrieves a single style from the Apparel21 system by accepting a required style ID parameter.

The endpoint checks that the style ID is valid and associated with an existing style record. If the style ID is valid, the endpoint retrieves the information for that specific style, including product code(style code), description, reference, custom data, colours and sizes.

Authorizations

Path parameters

shopify_idnumberRequired

The numeric Shopify product 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

400

Bad Request: The productId was invalid.

401

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

404

Not Found: The product with the specified productId was not found.

get

HTTPcURLJavaScriptPython

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

{
  "data": {
    "id": 123,
    "productCode": "MTS001",
    "sizeRange": "S-XXL",
    "name": "Men's T-Shirt",
    "description": "This classic crew-neck t-shirt is made with 100% cotton and is perfect for casual wear.",
    "updatedAt": "2023-02-27T09:30:00",
    "references": {
      "brand": {
        "code": "EB",
        "name": "ExampleBrand",
        "referenceValueId": 123
      },
      "category": {
        "code": "Tshirt",
        "name": "T-Shirts",
        "referenceValueId": 123
      }
    },
    "notes": {
      "careInstructions": "Machine wash cold, tumble dry low. Do not bleach."
    },
    "customData": {
      "online": {
        "newArrival": "true",
        "onlineExclusive": "true",
        "productType": "Casual"
      }
    },
    "colours": {
      "id": 123,
      "shopifyProductId": 1234567890,
      "colour": {
        "code": "text",
        "name": "text"
      },
      "markdownStatus": "None",
      "colourType": {
        "code": "text",
        "name": "text"
      },
      "references": {
        "subCategory": {
          "code": "Men",
          "name": "Men's",
          "referenceValueId": 123
        }
      },
      "notes": {
        "colour": "White"
      },
      "customData": {
        "online": {
          "newArrival": "false",
          "onlineExclusive": "false",
          "productType": "Casual"
        }
      },
      "sizes": {
        "id": 123,
        "sizeCode": "S",
        "originalPrice": 300,
        "price": 100,
        "sequence": 1,
        "barcode": "1234567890"
      }
    }
  }
}