Build Version:

GET skus

Gets a list of SKUs.

Request Information

» Expands

Name	Description	Usage
attributes	This will retrieve the related list of attributes.	GET skus?expand=attributes
inventory	This will retrieve the related inventory.	GET skus?expand=inventory
supplier	This will retrieve the related supplier.	GET skus?expand=supplier

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET skus?filter=externalid~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET skus?filter=isactive~{operator}~{value}
productId	This will filter the request by product ID.	GET skus?filter=productid~{operator}~{value}
sku	This will filter the request by SKU.	GET skus?filter=sku~{operator}~{value}
supplierId	This will filter the request by supplier ID.	GET skus?filter=supplierid~{operator}~{value}

» Sorting

Name	Description	Usage
displayOrder	This will sort the response by display order.	GET skus?sort=displayorder
productId	This will sort the response by product ID.	GET skus?sort=productid
sku	This will sort the response by SKU.	GET skus?sort=sku
skuId	This will sort the response by SKU ID.	GET skus?sort=skuid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET skus?page=index~{value}
size	The size of the page when retrieving paged results.	GET skus?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Skus": [
    {
      "Attributes": [
        {
          "AttributeId": 2,
          "AttributeType": null,
          "AttributeTypeId": 1,
          "DisplayOrder": 1,
          "ExternalId": "",
          "IsActive": true,
          "Name": "Red",
          "OldAttributeId": null,
          "AttributeTypeName": ""
        }
      ],
      "CustomerPricingSku": [],
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "DisplayOrder": null,
      "ExternalId": "",
      "FinalPrice": null,
      "ImageAltTag": "Green Apple",
      "ImageFile": "apple-green.jpg",
      "ImageLargePath": "~/data/default/images/catalog/450/apple-green.jpg",
      "ImageMediumPath": "~/data/default/images/catalog/250/apple-green.jpg",
      "ImageSmallPath": "~/data/default/images/catalog/100/apple-green.jpg",
      "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple-green.jpg",
      "ImageThumbnailPath": "~/data/default/images/catalog/50/apple-green.jpg",
      "Inventory": {
        "InventoryId": 1,
        "QuantityOnHand": 1000.0,
        "ReorderLevel": 10.0,
        "Sku": "apg234",
        "Skus": []
      },
      "IsActive": true,
      "Note": "",
      "ProductId": 302,
      "ProductPrice": null,
      "PromotionPrice": 1.23,
      "RecurringBillingFrequency": "1",
      "RecurringBillingInitialAmount": 0.00,
      "RecurringBillingPeriod": "",
      "RecurringBillingTotalCycles": 1,
      "RetailPriceOverride": null,
      "SalePriceOverride": 2.99,
      "Sku": "apg234",
      "SkuId": 2,
      "Supplier": {
        "ContactEmail": "john@smith.com",
        "ContactFirstName": "John",
        "ContactLastName": "Smith",
        "ContactPhone": "111-222-3333",
        "Custom1": "",
        "Custom2": "",
        "Custom3": "",
        "Custom4": "",
        "Custom5": "",
        "Description": "This is a supplier",
        "DisplayOrder": 1,
        "EmailNotificationTemplate": "",
        "EnableEmailNotification": true,
        "ExternalId": "",
        "ExternalSupplierNumber": "ABC123",
        "IsActive": true,
        "Name": "Supplier",
        "NotificationEmail": "supplier@supplier.com",
        "PortalId": null,
        "SupplierId": 1,
        "SupplierType": null,
        "SupplierTypeId": 1,
        "Address": null,
        "Account": null,
        "ClassName": null
      },
      "SupplierId": 1,
      "UpdateDate": "2013-12-06T02:04:16.85",
      "WebServiceDownloadDate": null,
      "WeightAdditional": 0.70,
      "WholesalePriceOverride": null,
      "AttributesIds": null,
      "Error": null,
      "UserType": null,
      "UserName": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}