### Stuller API Product Data Example

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This JSON object represents a single product's data as returned by the Stuller API. It includes comprehensive details about the product, its pricing, associated stones, images, and configuration possibilities.

```JSON
{
  "Products": [
    {
      "SKU": "sample string 1",
      "ShortDescription": "sample string 2",
      "SideStoneColorQuality": "sample string 3",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "IsOnPriceList": true,
      "OnHand": 1.0,
      "Orderable": true,
      "DescriptiveElementGroup": {
        "GroupName": "sample string 1",
        "GroupId": 2,
        "DescriptiveElements": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "DisplayValue": "sample string 3"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "DisplayValue": "sample string 3"
          }
        ]
      },
      "SetWith": [
        {
          "SKU": "sample string 1",
          "Quantity": 2,
          "Description": "sample string 3"
        },
        {
          "SKU": "sample string 1",
          "Quantity": 2,
          "Description": "sample string 3"
        }
      ],
      "CanBeSetWith": [
        {
          "Quantity": 1,
          "Shape": "sample string 2",
          "Size": "sample string 3",
          "SettingType": "sample string 4"
        },
        {
          "Quantity": 1,
          "Shape": "sample string 2",
          "Size": "sample string 3",
          "SettingType": "sample string 4"
        }
      ],
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "FullySetImages": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "ConfigurationModel": {
        "Id": 1,
        "IsPegHeadable": true,
        "RingSizeOptions": [
          {
            "Size": 1.0,
            "IsStockedSize": true,
            "Price": {
              "Value": 1.0,
              "CurrencyCode": "sample string 2"
            }
          },
          {
            "Size": 1.0,
            "IsStockedSize": true,
            "Price": {
              "Value": 1.0,
              "CurrencyCode": "sample string 2"
            }
          }
        ],
        "SettingOptions": [
          {
            "LocationNumber": 1,
            "StoneCount": 2,
            "SettingType": "sample string 3",
            "Description": "sample string 4",
            "SizeMM": 1.0,
            "Dimension1": 1.0,
            "Dimension2": 1.0,
            "Dimension3": 1.0,
            "GroupName": "sample string 5",
            "Shape": "sample string 6",
            "ShapeCode": 7
          },
          {
            "LocationNumber": 1,
            "StoneCount": 2,
            "SettingType": "sample string 3",
            "Description": "sample string 4",
            "SizeMM": 1.0,
            "Dimension1": 1.0,
            "Dimension2": 1.0,
            "Dimension3": 1.0,
            "GroupName": "sample string 5",
            "Shape": "sample string 6",
            "ShapeCode": 7
          }
        ],
        "EngravingOptions": [
          {
            "LocationNumber": 1,
            "Lines": 2,
            "Description": "sample string 3",
            "Types": [
              {
                "Id": 1,
                "Name": "sample string 2",
                "Description": "sample string 4",
                "Code": "sample string 3",
                "Fonts": [
                  {
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "MaxCharacters": 1,
                    "SampleImage": "sample string 4",
                    "ValidationPattern": "sample string 5",
                    "ValidationMessage": "sample string 6"
                  },
                  {
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "MaxCharacters": 1,
                    "SampleImage": "sample string 4",
                    "ValidationPattern": "sample string 5",
                    "ValidationMessage": "sample string 6"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Stuller API Product Data Example

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This JSON object represents a single product's data as returned by the Stuller API. It includes comprehensive details about the product's identification, pricing, physical attributes, associated stones, imagery, and configuration possibilities.

```JSON
{
  "Products": [
    {
      "SKU": "sample string 1",
      "ShortDescription": "sample string 2",
      "SideStoneColorQuality": "sample string 3",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "IsOnPriceList": true,
      "OnHand": 1.0,
      "Orderable": true,
      "DescriptiveElementGroup": {
        "GroupName": "sample string 1",
        "GroupId": 2,
        "DescriptiveElements": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "DisplayValue": "sample string 3"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2",
            "DisplayValue": "sample string 3"
          }
        ]
      },
      "SetWith": [
        {
          "SKU": "sample string 1",
          "Quantity": 2,
          "Description": "sample string 3"
        },
        {
          "SKU": "sample string 1",
          "Quantity": 2,
          "Description": "sample string 3"
        }
      ],
      "CanBeSetWith": [
        {
          "Quantity": 1,
          "Shape": "sample string 2",
          "Size": "sample string 3",
          "SettingType": "sample string 4"
        },
        {
          "Quantity": 1,
          "Shape": "sample string 2",
          "Size": "sample string 3",
          "SettingType": "sample string 4"
        }
      ],
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "FullySetImages": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "ConfigurationModel": {
        "Id": 1,
        "IsPegHeadable": true,
        "RingSizeOptions": [
          {
            "Size": 1.0,
            "IsStockedSize": true,
            "Price": {
              "Value": 1.0,
              "CurrencyCode": "sample string 2"
            }
          },
          {
            "Size": 1.0,
            "IsStockedSize": true,
            "Price": {
              "Value": 1.0,
              "CurrencyCode": "sample string 2"
            }
          }
        ],
        "SettingOptions": [
          {
            "LocationNumber": 1,
            "StoneCount": 2,
            "SettingType": "sample string 3",
            "Description": "sample string 4",
            "SizeMM": 1.0,
            "Dimension1": 1.0,
            "Dimension2": 1.0,
            "Dimension3": 1.0,
            "GroupName": "sample string 5",
            "Shape": "sample string 6",
            "ShapeCode": 7
          },
          {
            "LocationNumber": 1,
            "StoneCount": 2,
            "SettingType": "sample string 3",
            "Description": "sample string 4",
            "SizeMM": 1.0,
            "Dimension1": 1.0,
            "Dimension2": 1.0,
            "Dimension3": 1.0,
            "GroupName": "sample string 5",
            "Shape": "sample string 6",
            "ShapeCode": 7
          }
        ],
        "EngravingOptions": [
          {
            "LocationNumber": 1,
            "Lines": 2,
            "Description": "sample string 3",
            "Types": [
              {
                "Id": 1,
                "Name": "sample string 2",
                "Description": "sample string 4",
                "Code": "sample string 3",
                "Fonts": [
                  {
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "MaxCharacters": 1,
                    "SampleImage": "sample string 4",
                    "ValidationPattern": "sample string 5",
                    "ValidationMessage": "sample string 6"
                  },
                  {
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "MaxCharacters": 1,
                    "SampleImage": "sample string 4",
                    "ValidationPattern": "sample string 5",
                    "ValidationMessage": "sample string 6"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Stuller API Data Structure Example

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This snippet provides an example of the data structure used within the Stuller API. It includes details for labor, finishes, patterns, and fill options, along with nested color information.

```json
{
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

```json
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 4",
  "Code": "sample string 3",
  "Fonts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    }
  ],
  "Finishes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    }
  ],
  "Patterns": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    }
  ],
  "FillOptions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    }
  ],
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

```json
{
  "LocationNumber": 1,
  "Lines": 2,
  "Description": "sample string 3",
  "Types": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 4",
      "Code": "sample string 3",
      "Fonts": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3",
          "MaxCharacters": 1,
          "SampleImage": "sample string 4",
          "ValidationPattern": "sample string 5",
          "ValidationMessage": "sample string 6"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3",
          "MaxCharacters": 1,
          "SampleImage": "sample string 4",
          "ValidationPattern": "sample string 5",
          "ValidationMessage": "sample string 6"
        }
      ]
    }
  ]
}
```

--------------------------------

### Stuller API Data Structure Example

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This snippet provides an example of the data structure used within the Stuller API. It includes details for labor, finishes, patterns, and fill options, along with nested color information.

```json
{
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

```json
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 4",
  "Code": "sample string 3",
  "Fonts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    }
  ],
  "Finishes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    }
  ],
  "Patterns": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    }
  ],
  "FillOptions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    }
  ],
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

```json
{
  "LocationNumber": 1,
  "Lines": 2,
  "Description": "sample string 3",
  "Types": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 4",
      "Code": "sample string 3",
      "Fonts": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3",
          "MaxCharacters": 1,
          "SampleImage": "sample string 4",
          "ValidationPattern": "sample string 5",
          "ValidationMessage": "sample string 6"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3",
          "MaxCharacters": 1,
          "SampleImage": "sample string 4",
          "ValidationPattern": "sample string 5",
          "ValidationMessage": "sample string 6"
        }
      ]
    }
  ]
}
```

--------------------------------

### Product Details and Options

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This snippet shows the structure for product details, including IDs, SKUs, descriptions, and various customization options. It covers finishes, patterns, fill options with colors, and labor costs.

```JSON
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 4",
  "Code": "sample string 3",
  "Fonts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    }
  ],
  "Finishes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    }
  ],
  "Patterns": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    }
  ],
  "FillOptions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    }
  ],
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

--------------------------------

### Product Details and Options

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This snippet shows the structure for product details, including IDs, SKUs, descriptions, and various customization options. It covers finishes, patterns, fill options with colors, and labor costs.

```JSON
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 4",
  "Code": "sample string 3",
  "Fonts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    }
  ],
  "Finishes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    }
  ],
  "Patterns": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    }
  ],
  "FillOptions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    }
  ],
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

--------------------------------

### Retrieve Virtual Product Data - REST API

Source: https://api.stuller.com/Help/help

Returns data on 'virtual' semi-set inventory for items within the Stuller.com 3C Collection. These items serve as alternative starting points and are not directly searchable on Stuller.com.

```REST
GET api/v2/products/virtual
```

```REST
POST api/v2/products/virtual
```

--------------------------------

### Product Video URLs

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

Provides URLs for product videos, including playback and download links. Also includes group videos.

```json
{
  "Videos": [
    {
      "Url": "sample string 1",
      "DownloadUrl": "sample string 2"
    }
  ],
  "GroupVideos": [
    {
      "Url": "sample string 1",
      "DownloadUrl": "sample string 2"
    }
  ]
}
```

--------------------------------

### Retrieve Invoice and Shipment Information (Invoice API)

Source: https://api.stuller.com/Help/help

The Invoice API is used to retrieve available invoice and tracking information for previously placed orders. It includes endpoints to get general invoice and tracking details, as well as specific details for a given shipment.

```REST
GET api/v2/invoice
POST api/v2/invoice
GET api/v2/invoice/shipment?shipmentheaderid={shipmentheaderid}
POST api/v2/invoice/shipment
```

--------------------------------

### Product Configuration Model

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

Details the configuration options for a product, such as whether it's peg-headable and available ring sizes with their stock status and pricing.

```json
{
  "ConfigurationModel": {
    "Id": 1,
    "IsPegHeadable": true,
    "RingSizeOptions": [
      {
        "Size": 1.0,
        "IsStockedSize": true,
        "Price": {
          "Value": 1.0,
          "CurrencyCode": "sample string 2"
        }
      }
    ]
  }
}
```

--------------------------------

### Stuller Finish Data Structure

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This snippet outlines the structure for product finishes in the Stuller API, including ID, name, code, description, and sample images.

```JSON
{
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "Description": "sample string 4",
                    "WhiteSampleImage": "sample string 5",
                    "YellowSampleImage": "sample string 6"
                  }
```

--------------------------------

### POST api/v2/products/virtual XML Request

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This XML sample illustrates the structure for a request to the /api/v2/products/virtual endpoint, detailing how to specify parameters for virtual product data retrieval.

```xml
<ProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AdvancedProductFilters>
    <AdvancedProductFilter>
      <Type>ProductType</Type>
      <Values>
        <AdvancedProductFilterValue>
          <DisplayValue>sample string 1</DisplayValue>
          <Value>sample string 2</Value>
        </AdvancedProductFilterValue>
        <AdvancedProductFilterValue>
          <DisplayValue>sample string 1</DisplayValue>
          <Value>sample string 2</Value>
        </AdvancedProductFilterValue>
      </Values>
    </AdvancedProductFilter>
    <AdvancedProductFilter>
      <Type>ProductType</Type>
      <Values>
        <AdvancedProductFilterValue>
          <DisplayValue>sample string 1</DisplayValue>
          <Value>sample string 2</Value>
        </AdvancedProductFilterValue>
        <AdvancedProductFilterValue>
          <DisplayValue>sample string 1</DisplayValue>
          <Value>sample string 2</Value>
        </AdvancedProductFilterValue>
      </Values>
    </AdvancedProductFilter>
  </AdvancedProductFilters>
  <CategoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryIds>
  <Filter>
    <ProductFilter>OnPriceList</ProductFilter>
    <ProductFilter>OnPriceList</ProductFilter>
  </Filter>
  <Include>
    <ProductInclude>Default</ProductInclude>
    <ProductInclude>Default</ProductInclude>
  </Include>
  <NextPage>sample string 1</NextPage>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <ProductId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductId>
  <SKU xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SKU>
  <Series xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Series>
</ProductRequest>
```

--------------------------------

### Base Product Information

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This snippet outlines the basic information for a base product, including its ID, SKU, various descriptions, and merchandising categories.

```JSON
{
  "BaseProduct": {
    "Id": 1,
    "SKU": "sample string 2",
    "Description": "sample string 3",
    "ShortDescription": "sample string 4",
    "GroupDescription": "sample string 5",
    "LongGroupDescription": "sample string 6",
    "MerchandisingArea": "sample string 7",
    "MerchandisingCategory1": "sample string 8"
  }
}
```

--------------------------------

### Stuller API Base Product Details

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This JSON snippet outlines the core details of a base product, including its ID, SKU, various descriptions, and merchandising categorization.

```json
{
  "Id": 1,
  "SKU": "sample string 2",
  "Description": "sample string 3",
  "ShortDescription": "sample string 4",
  "GroupDescription": "sample string 5",
  "LongGroupDescription": "sample string 6",
  "MerchandisingArea": "sample string 7",
  "MerchandisingCategory1": "sample string 8",
  "MerchandisingCategory2": "sample string 9",
  "MerchandisingCategory3": "sample string 10",
  "MerchandisingCategory4": "sample string 11",
  "MerchandisingCategory5": "sample string 12",
  "WebCategories": []
}
```

--------------------------------

### Stuller Finish Data Structure

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This snippet outlines the structure for product finishes in the Stuller API, including ID, name, code, description, and sample images.

```JSON
{
                    "Id": 1,
                    "Name": "sample string 2",
                    "Code": "sample string 3",
                    "Description": "sample string 4",
                    "WhiteSampleImage": "sample string 5",
                    "YellowSampleImage": "sample string 6"
                  }
```

--------------------------------

### POST api/v2/products/virtual JSON Request

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This JSON sample demonstrates how to structure a request to the /api/v2/products/virtual endpoint. It includes parameters for filtering and retrieving virtual product inventory.

```json
{
  "Include": [
    "Default",
    "Default"
  ],
  "Filter": [
    "OnPriceList",
    "OnPriceList"
  ],
  "Series": [
    "sample string 1",
    "sample string 2"
  ],
  "SKU": [
    "sample string 1",
    "sample string 2"
  ],
  "ProductId": [
    1,
    2
  ],
  "CategoryIds": [
    1,
    2
  ],
  "AdvancedProductFilters": [
    {
      "Type": "ProductType",
      "Values": [
        {
          "DisplayValue": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "DisplayValue": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Type": "ProductType",
      "Values": [
        {
          "DisplayValue": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "DisplayValue": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "NextPage": "sample string 1",
  "Page": 1,
  "PageSize": 1
}
```

--------------------------------

### Stuller API Base Product Details

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This JSON snippet outlines the core details of a base product, including its ID, SKU, various descriptions, and merchandising categorization.

```json
{
  "Id": 1,
  "SKU": "sample string 2",
  "Description": "sample string 3",
  "ShortDescription": "sample string 4",
  "GroupDescription": "sample string 5",
  "LongGroupDescription": "sample string 6",
  "MerchandisingArea": "sample string 7",
  "MerchandisingCategory1": "sample string 8",
  "MerchandisingCategory2": "sample string 9",
  "MerchandisingCategory3": "sample string 10",
  "MerchandisingCategory4": "sample string 11",
  "MerchandisingCategory5": "sample string 12",
  "WebCategories": []
}
```

--------------------------------

### Product Data Structure

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This JSON structure represents a product's detailed information, including its ID, name, path, pricing, stock status, and descriptive elements. It also includes related items like 'SetWith' and 'MadeWith' components, as well as image and video URLs.

```json
{
  "Id": 1,
  "Name": "sample string 2",
  "Path": "sample string 3",
  "CategoryImageUrl": "sample string 4",
  "Collection": "sample string 13",
  "OnHand": 1.0,
  "Status": "sample string 14",
  "Orderable": true,
  "Price": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  },
  "CustomerSpecificPrice": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  },
  "ShowcasePrice": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  },
  "IsOnPriceList": true,
  "UnitOfSale": "sample string 16",
  "Weight": 1.0,
  "WeightUnitOfMeasure": "sample string 17",
  "GramWeight": 1.0,
  "RingSizable": true,
  "RingSize": 1.0,
  "RingSizeType": "Approximate",
  "LeadTime": 1,
  "DescriptiveElementGroup": {
    "GroupName": "sample string 1",
    "GroupId": 2,
    "DescriptiveElements": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2",
        "DisplayValue": "sample string 3"
      }
    ]
  },
  "SetWith": [
    {
      "SKU": "sample string 1",
      "Quantity": 2,
      "Description": "sample string 3"
    }
  ],
  "CanBeSetWith": [
    {
      "Quantity": 1,
      "Shape": "sample string 2",
      "Size": "sample string 3",
      "SettingType": "sample string 4"
    }
  ],
  "MadeWith": [
    {
      "SKU": "sample string 1",
      "Quantity": 2,
      "Description": "sample string 3",
      "UnitOfSale": "sample string 4"
    }
  ],
  "StoneMapImage": "sample string 18",
  "Images": [
    {
      "FullUrl": "sample string 1",
      "ThumbnailUrl": "sample string 2",
      "ZoomUrl": "sample string 3",
      "SortOrder": 4,
      "MaxHeight": 1,
      "MaxWidth": 1,
      "Angle": "sample string 5"
    }
  ],
  "GroupImages": [
    {
      "FullUrl": "sample string 1",
      "ThumbnailUrl": "sample string 2",
      "ZoomUrl": "sample string 3",
      "SortOrder": 4,
      "MaxHeight": 1,
      "MaxWidth": 1,
      "Angle": "sample string 5"
    }
  ],
  "Videos": [
    {
      "Url": "sample string 1",
      "DownloadUrl": "sample string 2"
    }
  ],
  "GroupVideos": [
    {
      "Url": "sample string 1",
      "DownloadUrl": "sample string 2"
    }
  ],
  "ConfigurationModel": {
    "Id": 1,
    "IsPegHeadable": true,
    "RingSizeOptions": [
      {
        "Size": 1.0,
        "IsStockedSize": true,
        "Price": {
          "Value": 1.0,
          "CurrencyCode": "sample string 2"
        }
      }
    ],
    "SettingOptions": [
      {
        "Shape": "sample string 2",
        "Size": "sample string 3",
        "SettingType": "sample string 4"
      }
    ]
  }
}
```

--------------------------------

### Base Product Information

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

This snippet outlines the basic information for a base product, including its ID, SKU, various descriptions, and merchandising categories.

```JSON
{
  "BaseProduct": {
    "Id": 1,
    "SKU": "sample string 2",
    "Description": "sample string 3",
    "ShortDescription": "sample string 4",
    "GroupDescription": "sample string 5",
    "LongGroupDescription": "sample string 6",
    "MerchandisingArea": "sample string 7",
    "MerchandisingCategory1": "sample string 8"
  }
}
```

--------------------------------

### Product Image URLs

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

Contains URLs for different versions of product images, including full, thumbnail, and zoom views, along with sorting order and dimensions. Also includes group images.

```json
{
  "Images": [
    {
      "FullUrl": "sample string 1",
      "ThumbnailUrl": "sample string 2",
      "ZoomUrl": "sample string 3",
      "SortOrder": 4,
      "MaxHeight": 1,
      "MaxWidth": 1,
      "Angle": "sample string 5"
    }
  ],
  "GroupImages": [
    {
      "FullUrl": "sample string 1",
      "ThumbnailUrl": "sample string 2",
      "ZoomUrl": "sample string 3",
      "SortOrder": 4,
      "MaxHeight": 1,
      "MaxWidth": 1,
      "Angle": "sample string 5"
    }
  ]
}
```

--------------------------------

### Finishes Data Structure

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

Represents the structure for product finishes, including ID, name, code, description, and sample images for white and yellow variations.

```json
{
  "Id": 1,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "Description": "sample string 4",
  "WhiteSampleImage": "sample string 5",
  "YellowSampleImage": "sample string 6"
}
```

--------------------------------

### Stuller API Product Data Structure

Source: https://api.stuller.com/Help/Api/GET-namespace-v2

This JSON structure represents a comprehensive view of a product available through the Stuller API. It includes identifiers, names, descriptions, and codes for the base product, as well as detailed information about various customization options.

```json
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 4",
  "Code": "sample string 3",
  "Fonts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "MaxCharacters": 1,
      "SampleImage": "sample string 4",
      "ValidationPattern": "sample string 5",
      "ValidationMessage": "sample string 6"
    }
  ],
  "Finishes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "WhiteSampleImage": "sample string 5",
      "YellowSampleImage": "sample string 6"
    }
  ],
  "Patterns": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "SampleImage": "sample string 4"
    }
  ],
  "FillOptions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Description": "sample string 4",
      "Colors": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      ]
    }
  ],
  "Labor": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```

--------------------------------

### Product Pricing Information

Source: https://api.stuller.com/Help/Api/POST-namespace-v2

Details the pricing for a product, including the base value and currency code. It also includes customer-specific and showcase pricing if applicable.

```json
{
  "Price": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  },
  "CustomerSpecificPrice": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  },
  "ShowcasePrice": {
    "Value": 1.0,
    "CurrencyCode": "sample string 2"
  }
}
```